Pinpoint / Client / get_campaign_date_range_kpi

get_campaign_date_range_kpi#

Pinpoint.Client.get_campaign_date_range_kpi(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_campaign_date_range_kpi(
    ApplicationId='string',
    CampaignId='string',
    EndTime=datetime(2015, 1, 1),
    KpiName='string',
    NextToken='string',
    PageSize='string',
    StartTime=datetime(2015, 1, 1)
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

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

  • CampaignId (string) –

    [REQUIRED]

    The unique identifier for the campaign.

  • EndTime (datetime) – The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

  • KpiName (string) –

    [REQUIRED]

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

  • NextToken (string) – 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.

  • PageSize (string) – 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.

  • StartTime (datetime) – The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

Return type:

dict

Returns:

Response Syntax

{
    'CampaignDateRangeKpiResponse': {
        'ApplicationId': 'string',
        'CampaignId': 'string',
        'EndTime': datetime(2015, 1, 1),
        'KpiName': 'string',
        'KpiResult': {
            'Rows': [
                {
                    'GroupedBys': [
                        {
                            'Key': 'string',
                            'Type': 'string',
                            'Value': 'string'
                        },
                    ],
                    'Values': [
                        {
                            'Key': 'string',
                            'Type': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ]
        },
        'NextToken': 'string',
        'StartTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    The request succeeded.

    • CampaignDateRangeKpiResponse (dict) –

      Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.

      • ApplicationId (string) –

        The unique identifier for the application that the metric applies to.

      • CampaignId (string) –

        The unique identifier for the campaign that the metric applies to.

      • EndTime (datetime) –

        The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

      • KpiName (string) –

        The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

      • KpiResult (dict) –

        An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

        • Rows (list) –

          An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

          • (dict) –

            Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

            • GroupedBys (list) –

              An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

              • (dict) –

                Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.

                • Key (string) –

                  The friendly name of the metric whose value is specified by the Value property.

                • Type (string) –

                  The data type of the value specified by the Value property.

                • Value (string) –

                  In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

            • Values (list) –

              An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

              • (dict) –

                Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.

                • Key (string) –

                  The friendly name of the metric whose value is specified by the Value property.

                • Type (string) –

                  The data type of the value specified by the Value property.

                • Value (string) –

                  In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

      • 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 for the Campaign Metrics resource because the resource returns all results in a single page.

      • StartTime (datetime) –

        The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

Exceptions