AWSPinpointTargetingGetJourneyDateRangeKpiRequest

Objective-C

@interface AWSPinpointTargetingGetJourneyDateRangeKpiRequest

Swift

class AWSPinpointTargetingGetJourneyDateRangeKpiRequest

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable applicationId;

    Swift

    var applicationId: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable endTime;

    Swift

    var endTime: Date? { get set }

  • The unique identifier for the journey.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable journeyId;

    Swift

    var journeyId: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable kpiName;

    Swift

    var kpiName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable nextToken;

    Swift

    var nextToken: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable pageSize;

    Swift

    var pageSize: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startTime;

    Swift

    var startTime: Date? { get set }