JourneyDateRangeKpiResponse class

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.

Constructors

JourneyDateRangeKpiResponse({required String applicationId, required DateTime endTime, required String journeyId, required String kpiName, required BaseKpiResult kpiResult, required DateTime startTime, String? nextToken})

JourneyDateRangeKpiResponse.fromJson(Map<String, dynamic> json)

factory

Properties

applicationId → String

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

final

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.

final

hashCode → int

The hash code for this object.

no setter, inherited

journeyId → String

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

final

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.

final

kpiResult → BaseKpiResult

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

final

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited