AWSPinpointTargetingJourneyDateRangeKpiResponse

Objective-C

@interface AWSPinpointTargetingJourneyDateRangeKpiResponse

Swift

class AWSPinpointTargetingJourneyDateRangeKpiResponse

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

Required parameters: [KpiResult, KpiName, JourneyId, EndTime, StartTime, ApplicationId]

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

    Declaration

    Objective-C

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

    Swift

    var applicationId: String? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var endTime: Date? { get set }

  • The unique identifier for the journey that the metric applies to.

    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), 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.

    Declaration

    Objective-C

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

    Swift

    var kpiName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSPinpointTargetingBaseKpiResult *_Nullable kpiResult;

    Swift

    var kpiResult: AWSPinpointTargetingBaseKpiResult? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var nextToken: String? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var startTime: Date? { get set }