AWS API Changes

2023/04/25 - Amazon Pinpoint - 3 new1 updated api methods

Changes Adds support for journey runs and querying journey execution metrics based on journey runs. Adds execution metrics to campaign activities. Updates docs for Advanced Quiet Time.

GetJourneyRunExecutionActivityMetrics (new)

Link ¶

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.

See also: AWS API Documentation

Request Syntax

client.get_journey_run_execution_activity_metrics(
    ApplicationId='string',
    JourneyActivityId='string',
    JourneyId='string',
    NextToken='string',
    PageSize='string',
    RunId='string'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

type JourneyActivityId:

string

param JourneyActivityId:

[REQUIRED]

The unique identifier for the journey activity.

type JourneyId:

string

param JourneyId:

[REQUIRED]

The unique identifier for the journey.

type NextToken:

string

param NextToken:

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

type PageSize:

string

param PageSize:

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

type RunId:

string

param RunId:

[REQUIRED]

The unique identifier for the journey run.

rtype:

dict

returns:

Response Syntax

{
    'JourneyRunExecutionActivityMetricsResponse': {
        'ActivityType': 'string',
        'ApplicationId': 'string',
        'JourneyActivityId': 'string',
        'JourneyId': 'string',
        'LastEvaluatedTime': 'string',
        'Metrics': {
            'string': 'string'
        },
        'RunId': 'string'
    }
}

Response Structure

(dict) --

The request succeeded.
- JourneyRunExecutionActivityMetricsResponse (dict) --
  
  Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.
  - ActivityType (string) --
    
    The type of activity that the metric applies to. Possible values are:
    - CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
    - HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
    - MESSAGE – For an email activity, which is an activity that sends an email message to participants.
    - MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
    - RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
    - WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
  - ApplicationId (string) --
    
    The unique identifier for the application that the metric applies to.
  - JourneyActivityId (string) --
    
    The unique identifier for the activity that the metric applies to.
  - JourneyId (string) --
    
    The unique identifier for the journey that the metric applies to.
  - LastEvaluatedTime (string) --
    
    The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.
  - Metrics (dict) --
    
    A JSON object that contains the results of the query. For information about the structure and contents of the results, see see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
    - (string) --
      - (string) --
  - RunId (string) --
    
    The unique identifier for the journey run that the metric applies to.

GetJourneyRunExecutionMetrics (new)

Link ¶

Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.

See also: AWS API Documentation

Request Syntax

client.get_journey_run_execution_metrics(
    ApplicationId='string',
    JourneyId='string',
    NextToken='string',
    PageSize='string',
    RunId='string'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

type JourneyId:

string

param JourneyId:

[REQUIRED]

The unique identifier for the journey.

type NextToken:

string

param NextToken:

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

type PageSize:

string

param PageSize:

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

type RunId:

string

param RunId:

[REQUIRED]

The unique identifier for the journey run.

rtype:

dict

returns:

Response Syntax

{
    'JourneyRunExecutionMetricsResponse': {
        'ApplicationId': 'string',
        'JourneyId': 'string',
        'LastEvaluatedTime': 'string',
        'Metrics': {
            'string': 'string'
        },
        'RunId': 'string'
    }
}

Response Structure

(dict) --

The request succeeded.
- JourneyRunExecutionMetricsResponse (dict) --
  
  Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.
  - ApplicationId (string) --
    
    The unique identifier for the application that the metric applies to.
  - JourneyId (string) --
    
    The unique identifier for the journey that the metric applies to.
  - LastEvaluatedTime (string) --
    
    The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey run and updated the data for the metric.
  - Metrics (dict) --
    
    A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
    - (string) --
      - (string) --
  - RunId (string) --
    
    The unique identifier for the journey run that the metric applies to.

GetJourneyRuns (new)

Link ¶

Provides information about the runs of a journey.

See also: AWS API Documentation

Request Syntax

client.get_journey_runs(
    ApplicationId='string',
    JourneyId='string',
    PageSize='string',
    Token='string'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

type JourneyId:

string

param JourneyId:

[REQUIRED]

The unique identifier for the journey.

type PageSize:

string

param PageSize:

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

type Token:

string

param Token:

The NextToken string that specifies which page of results to return in a paginated response.

rtype:

dict

returns:

Response Syntax

{
    'JourneyRunsResponse': {
        'Item': [
            {
                'CreationTime': 'string',
                'LastUpdateTime': 'string',
                'RunId': 'string',
                'Status': 'SCHEDULED'|'RUNNING'|'COMPLETED'|'CANCELLED'
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) --

The request succeeded.
- JourneyRunsResponse (dict) --
  
  Provides information from all runs of a journey.
  - Item (list) --
    
    An array of responses, one for each run of the journey
    - (dict) --
      
      Provides information from a specified run of a journey.
      - CreationTime (string) --
        
        The time when the journey run was created or scheduled, in ISO 8601 format.
      - LastUpdateTime (string) --
        
        The last time the journey run was updated, in ISO 8601 format..
      - RunId (string) --
        
        The unique identifier for the run.
      - Status (string) --
        
        The current status of the journey run.
  - NextToken (string) --
    
    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

GetCampaignActivities (updated)

Link ¶
Changes (response)

{'ActivitiesResponse': {'Item': {'ExecutionMetrics': {'string': 'string'}}}}

Retrieves information about all the activities for a campaign.

See also: AWS API Documentation

Request Syntax

client.get_campaign_activities(
    ApplicationId='string',
    CampaignId='string',
    PageSize='string',
    Token='string'
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED]

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

type CampaignId:

string

param CampaignId:

[REQUIRED]

The unique identifier for the campaign.

type PageSize:

string

param PageSize:

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

type Token:

string

param Token:

The NextToken string that specifies which page of results to return in a paginated response.

rtype:

dict

returns:

Response Syntax

{
    'ActivitiesResponse': {
        'Item': [
            {
                'ApplicationId': 'string',
                'CampaignId': 'string',
                'End': 'string',
                'Id': 'string',
                'Result': 'string',
                'ScheduledStart': 'string',
                'Start': 'string',
                'State': 'string',
                'SuccessfulEndpointCount': 123,
                'TimezonesCompletedCount': 123,
                'TimezonesTotalCount': 123,
                'TotalEndpointCount': 123,
                'TreatmentId': 'string',
                'ExecutionMetrics': {
                    'string': 'string'
                }
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

(dict) --

The request succeeded.
- ActivitiesResponse (dict) --
  
  Provides information about the activities that were performed by a campaign.
  - Item (list) --
    
    An array of responses, one for each activity that was performed by the campaign.
    - (dict) --
      
      Provides information about an activity that was performed by a campaign.
      - ApplicationId (string) --
        
        The unique identifier for the application that the campaign applies to.
      - CampaignId (string) --
        
        The unique identifier for the campaign that the activity applies to.
      - End (string) --
        
        The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
      - Id (string) --
        
        The unique identifier for the activity.
      - Result (string) --
        
        Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
      - ScheduledStart (string) --
        
        The scheduled start time, in ISO 8601 format, for the activity.
      - Start (string) --
        
        The actual start time, in ISO 8601 format, of the activity.
      - State (string) --
        
        The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
      - SuccessfulEndpointCount (integer) --
        
        The total number of endpoints that the campaign successfully delivered messages to.
      - TimezonesCompletedCount (integer) --
        
        The total number of time zones that were completed.
      - TimezonesTotalCount (integer) --
        
        The total number of unique time zones that are in the segment for the campaign.
      - TotalEndpointCount (integer) --
        
        The total number of endpoints that the campaign attempted to deliver messages to.
      - TreatmentId (string) --
        
        The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
      - ExecutionMetrics (dict) --
        
        A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
        
        (string) --
        
        (string) --
  - NextToken (string) --
    
    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.