Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.GetJourneyDateRangeKpi

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

Synopsis

data GetJourneyDateRangeKpi = GetJourneyDateRangeKpi' {
- startTime :: Maybe POSIX
- nextToken :: Maybe Text
- endTime :: Maybe POSIX
- pageSize :: Maybe Text
- journeyId :: Text
- applicationId :: Text
- kpiName :: Text
}
newGetJourneyDateRangeKpi :: Text -> Text -> Text -> GetJourneyDateRangeKpi
getJourneyDateRangeKpi_startTime :: Lens' GetJourneyDateRangeKpi (Maybe UTCTime)
getJourneyDateRangeKpi_nextToken :: Lens' GetJourneyDateRangeKpi (Maybe Text)
getJourneyDateRangeKpi_endTime :: Lens' GetJourneyDateRangeKpi (Maybe UTCTime)
getJourneyDateRangeKpi_pageSize :: Lens' GetJourneyDateRangeKpi (Maybe Text)
getJourneyDateRangeKpi_journeyId :: Lens' GetJourneyDateRangeKpi Text
getJourneyDateRangeKpi_applicationId :: Lens' GetJourneyDateRangeKpi Text
getJourneyDateRangeKpi_kpiName :: Lens' GetJourneyDateRangeKpi Text
data GetJourneyDateRangeKpiResponse = GetJourneyDateRangeKpiResponse' {
- httpStatus :: Int
- journeyDateRangeKpiResponse :: JourneyDateRangeKpiResponse
}
newGetJourneyDateRangeKpiResponse :: Int -> JourneyDateRangeKpiResponse -> GetJourneyDateRangeKpiResponse
getJourneyDateRangeKpiResponse_httpStatus :: Lens' GetJourneyDateRangeKpiResponse Int
getJourneyDateRangeKpiResponse_journeyDateRangeKpiResponse :: Lens' GetJourneyDateRangeKpiResponse JourneyDateRangeKpiResponse

Creating a Request

data GetJourneyDateRangeKpi Source #

See: newGetJourneyDateRangeKpi smart constructor.

Constructors

GetJourneyDateRangeKpi'

Fields

startTime :: Maybe POSIX
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.
nextToken :: Maybe Text
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.
endTime :: Maybe POSIX
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.
pageSize :: Maybe Text
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.
journeyId :: Text
The unique identifier for the journey.
applicationId :: Text
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
kpiName :: Text
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.

Instances

Instances details

Eq GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods (==) :: GetJourneyDateRangeKpi -> GetJourneyDateRangeKpi -> Bool # (/=) :: GetJourneyDateRangeKpi -> GetJourneyDateRangeKpi -> Bool #
Read GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods readsPrec :: Int -> ReadS GetJourneyDateRangeKpi # readList :: ReadS [GetJourneyDateRangeKpi] # readPrec :: ReadPrec GetJourneyDateRangeKpi # readListPrec :: ReadPrec [GetJourneyDateRangeKpi] #
Show GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods showsPrec :: Int -> GetJourneyDateRangeKpi -> ShowS # show :: GetJourneyDateRangeKpi -> String # showList :: [GetJourneyDateRangeKpi] -> ShowS #
Generic GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Associated Types type Rep GetJourneyDateRangeKpi :: Type -> Type # Methods from :: GetJourneyDateRangeKpi -> Rep GetJourneyDateRangeKpi x # to :: Rep GetJourneyDateRangeKpi x -> GetJourneyDateRangeKpi #
NFData GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods rnf :: GetJourneyDateRangeKpi -> () #
Hashable GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods hashWithSalt :: Int -> GetJourneyDateRangeKpi -> Int # hash :: GetJourneyDateRangeKpi -> Int #
AWSRequest GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Associated Types type AWSResponse GetJourneyDateRangeKpi # Methods request :: GetJourneyDateRangeKpi -> Request GetJourneyDateRangeKpi # response :: MonadResource m => Logger -> Service -> Proxy GetJourneyDateRangeKpi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetJourneyDateRangeKpi))) #
ToHeaders GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods toHeaders :: GetJourneyDateRangeKpi -> [Header] #
ToPath GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods toPath :: GetJourneyDateRangeKpi -> ByteString #
ToQuery GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods toQuery :: GetJourneyDateRangeKpi -> QueryString #
type Rep GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi type Rep GetJourneyDateRangeKpi = D1 ('MetaData "GetJourneyDateRangeKpi" "Amazonka.Pinpoint.GetJourneyDateRangeKpi" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetJourneyDateRangeKpi'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "journeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "kpiName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse GetJourneyDateRangeKpi Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi type AWSResponse GetJourneyDateRangeKpi = GetJourneyDateRangeKpiResponse

newGetJourneyDateRangeKpi Source #

Arguments

:: Text	`$sel:journeyId:GetJourneyDateRangeKpi'`
-> Text	`$sel:applicationId:GetJourneyDateRangeKpi'`
-> Text	`$sel:kpiName:GetJourneyDateRangeKpi'`
-> GetJourneyDateRangeKpi

Create a value of GetJourneyDateRangeKpi 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:startTime:GetJourneyDateRangeKpi', getJourneyDateRangeKpi_startTime - 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.

$sel:nextToken:GetJourneyDateRangeKpi', getJourneyDateRangeKpi_nextToken - 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.

$sel:endTime:GetJourneyDateRangeKpi', getJourneyDateRangeKpi_endTime - 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.

$sel:pageSize:GetJourneyDateRangeKpi', getJourneyDateRangeKpi_pageSize - 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.

$sel:journeyId:GetJourneyDateRangeKpi', getJourneyDateRangeKpi_journeyId - The unique identifier for the journey.

$sel:applicationId:GetJourneyDateRangeKpi', getJourneyDateRangeKpi_applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

$sel:kpiName:GetJourneyDateRangeKpi', getJourneyDateRangeKpi_kpiName - 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.

Request Lenses

getJourneyDateRangeKpi_startTime :: Lens' GetJourneyDateRangeKpi (Maybe UTCTime) Source #

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.

getJourneyDateRangeKpi_nextToken :: Lens' GetJourneyDateRangeKpi (Maybe Text) Source #

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.

getJourneyDateRangeKpi_endTime :: Lens' GetJourneyDateRangeKpi (Maybe UTCTime) Source #

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.

getJourneyDateRangeKpi_pageSize :: Lens' GetJourneyDateRangeKpi (Maybe Text) Source #

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.

getJourneyDateRangeKpi_journeyId :: Lens' GetJourneyDateRangeKpi Text Source #

The unique identifier for the journey.

getJourneyDateRangeKpi_applicationId :: Lens' GetJourneyDateRangeKpi Text Source #

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

getJourneyDateRangeKpi_kpiName :: Lens' GetJourneyDateRangeKpi Text Source #

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.

Destructuring the Response

data GetJourneyDateRangeKpiResponse Source #

See: newGetJourneyDateRangeKpiResponse smart constructor.

Constructors

GetJourneyDateRangeKpiResponse'
Fields httpStatus :: Int The response's http status code. journeyDateRangeKpiResponse :: JourneyDateRangeKpiResponse

Instances

Instances details

Eq GetJourneyDateRangeKpiResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods (==) :: GetJourneyDateRangeKpiResponse -> GetJourneyDateRangeKpiResponse -> Bool # (/=) :: GetJourneyDateRangeKpiResponse -> GetJourneyDateRangeKpiResponse -> Bool #
Read GetJourneyDateRangeKpiResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods readsPrec :: Int -> ReadS GetJourneyDateRangeKpiResponse # readList :: ReadS [GetJourneyDateRangeKpiResponse] # readPrec :: ReadPrec GetJourneyDateRangeKpiResponse # readListPrec :: ReadPrec [GetJourneyDateRangeKpiResponse] #
Show GetJourneyDateRangeKpiResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods showsPrec :: Int -> GetJourneyDateRangeKpiResponse -> ShowS # show :: GetJourneyDateRangeKpiResponse -> String # showList :: [GetJourneyDateRangeKpiResponse] -> ShowS #
Generic GetJourneyDateRangeKpiResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Associated Types type Rep GetJourneyDateRangeKpiResponse :: Type -> Type # Methods from :: GetJourneyDateRangeKpiResponse -> Rep GetJourneyDateRangeKpiResponse x # to :: Rep GetJourneyDateRangeKpiResponse x -> GetJourneyDateRangeKpiResponse #
NFData GetJourneyDateRangeKpiResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi Methods rnf :: GetJourneyDateRangeKpiResponse -> () #
type Rep GetJourneyDateRangeKpiResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyDateRangeKpi type Rep GetJourneyDateRangeKpiResponse = D1 ('MetaData "GetJourneyDateRangeKpiResponse" "Amazonka.Pinpoint.GetJourneyDateRangeKpi" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetJourneyDateRangeKpiResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "journeyDateRangeKpiResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JourneyDateRangeKpiResponse)))

newGetJourneyDateRangeKpiResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetJourneyDateRangeKpiResponse'`
-> JourneyDateRangeKpiResponse	`$sel:journeyDateRangeKpiResponse:GetJourneyDateRangeKpiResponse'`
-> GetJourneyDateRangeKpiResponse

Create a value of GetJourneyDateRangeKpiResponse 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:httpStatus:GetJourneyDateRangeKpiResponse', getJourneyDateRangeKpiResponse_httpStatus - The response's http status code.

$sel:journeyDateRangeKpiResponse:GetJourneyDateRangeKpiResponse', getJourneyDateRangeKpiResponse_journeyDateRangeKpiResponse - Undocumented member.

Response Lenses

getJourneyDateRangeKpiResponse_httpStatus :: Lens' GetJourneyDateRangeKpiResponse Int Source #

The response's http status code.

getJourneyDateRangeKpiResponse_journeyDateRangeKpiResponse :: Lens' GetJourneyDateRangeKpiResponse JourneyDateRangeKpiResponse Source #

Undocumented member.