libZSservicesZSamazonka-pinpointZSamazonka-pinpoint
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Description

 
Synopsis

Documentation

data JourneyDateRangeKpiResponse Source #

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.

See: newJourneyDateRangeKpiResponse smart constructor.

Constructors

JourneyDateRangeKpiResponse' 

Fields

  • nextToken :: Maybe Text

    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.

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

  • kpiName :: Text

    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.

  • journeyId :: Text

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

  • endTime :: POSIX

    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.

  • startTime :: POSIX

    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.

  • applicationId :: Text

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

Instances

Instances details
Eq JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Read JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Show JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Generic JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Associated Types

type Rep JourneyDateRangeKpiResponse :: Type -> Type #

NFData JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

Hashable JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

FromJSON JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

type Rep JourneyDateRangeKpiResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse

type Rep JourneyDateRangeKpiResponse = D1 ('MetaData "JourneyDateRangeKpiResponse" "Amazonka.Pinpoint.Types.JourneyDateRangeKpiResponse" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "JourneyDateRangeKpiResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kpiResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BaseKpiResult) :*: S1 ('MetaSel ('Just "kpiName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "journeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newJourneyDateRangeKpiResponse Source #

Create a value of JourneyDateRangeKpiResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_nextToken - 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.

$sel:kpiResult:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_kpiResult - An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

$sel:kpiName:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_kpiName - 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.

$sel:journeyId:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_journeyId - The unique identifier for the journey that the metric applies to.

$sel:endTime:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_endTime - 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.

$sel:startTime:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_startTime - 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.

$sel:applicationId:JourneyDateRangeKpiResponse', journeyDateRangeKpiResponse_applicationId - The unique identifier for the application that the metric applies to.

journeyDateRangeKpiResponse_nextToken :: Lens' JourneyDateRangeKpiResponse (Maybe Text) Source #

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.

journeyDateRangeKpiResponse_kpiResult :: Lens' JourneyDateRangeKpiResponse BaseKpiResult Source #

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

journeyDateRangeKpiResponse_kpiName :: Lens' JourneyDateRangeKpiResponse Text Source #

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.

journeyDateRangeKpiResponse_journeyId :: Lens' JourneyDateRangeKpiResponse Text Source #

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

journeyDateRangeKpiResponse_endTime :: Lens' JourneyDateRangeKpiResponse UTCTime Source #

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.

journeyDateRangeKpiResponse_startTime :: Lens' JourneyDateRangeKpiResponse UTCTime Source #

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.

journeyDateRangeKpiResponse_applicationId :: Lens' JourneyDateRangeKpiResponse Text Source #

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