NAME

Paws::Pinpoint::GetJourneyDateRangeKpi - Arguments for method GetJourneyDateRangeKpi on Paws::Pinpoint

DESCRIPTION

This class represents the parameters used for calling the method GetJourneyDateRangeKpi on the Amazon Pinpoint service. Use the attributes of this class as arguments to method GetJourneyDateRangeKpi.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetJourneyDateRangeKpi.

SYNOPSIS

    my $pinpoint = Paws->service('Pinpoint');
    my $GetJourneyDateRangeKpiResponse = $pinpoint->GetJourneyDateRangeKpi(
      ApplicationId => 'My__string',
      JourneyId     => 'My__string',
      KpiName       => 'My__string',
      EndTime       => '1970-01-01T01:00:00',    # OPTIONAL
      NextToken     => 'My__string',             # OPTIONAL
      PageSize      => 'My__string',             # OPTIONAL
      StartTime     => '1970-01-01T01:00:00',    # OPTIONAL
    );
    # Results:
    my $JourneyDateRangeKpiResponse =
      $GetJourneyDateRangeKpiResponse->JourneyDateRangeKpiResponse;
    # Returns a L<Paws::Pinpoint::GetJourneyDateRangeKpiResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/pinpoint/GetJourneyDateRangeKpi>

ATTRIBUTES

REQUIRED ApplicationId => Str

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

EndTime => Str

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.

REQUIRED JourneyId => Str

The unique identifier for the journey.

REQUIRED KpiName => Str

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 (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html).

NextToken => Str

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 => Str

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 => Str

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.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>