| 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.GetCampaignDateRangeKpi
Description
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
Synopsis
- data GetCampaignDateRangeKpi = GetCampaignDateRangeKpi' {}
- newGetCampaignDateRangeKpi :: Text -> Text -> Text -> GetCampaignDateRangeKpi
- getCampaignDateRangeKpi_startTime :: Lens' GetCampaignDateRangeKpi (Maybe UTCTime)
- getCampaignDateRangeKpi_nextToken :: Lens' GetCampaignDateRangeKpi (Maybe Text)
- getCampaignDateRangeKpi_endTime :: Lens' GetCampaignDateRangeKpi (Maybe UTCTime)
- getCampaignDateRangeKpi_pageSize :: Lens' GetCampaignDateRangeKpi (Maybe Text)
- getCampaignDateRangeKpi_applicationId :: Lens' GetCampaignDateRangeKpi Text
- getCampaignDateRangeKpi_kpiName :: Lens' GetCampaignDateRangeKpi Text
- getCampaignDateRangeKpi_campaignId :: Lens' GetCampaignDateRangeKpi Text
- data GetCampaignDateRangeKpiResponse = GetCampaignDateRangeKpiResponse' {}
- newGetCampaignDateRangeKpiResponse :: Int -> CampaignDateRangeKpiResponse -> GetCampaignDateRangeKpiResponse
- getCampaignDateRangeKpiResponse_httpStatus :: Lens' GetCampaignDateRangeKpiResponse Int
- getCampaignDateRangeKpiResponse_campaignDateRangeKpiResponse :: Lens' GetCampaignDateRangeKpiResponse CampaignDateRangeKpiResponse
Creating a Request
data GetCampaignDateRangeKpi Source #
See: newGetCampaignDateRangeKpi smart constructor.
Constructors
| GetCampaignDateRangeKpi' | |
Fields
| |
Instances
newGetCampaignDateRangeKpi Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> GetCampaignDateRangeKpi |
Create a value of GetCampaignDateRangeKpi 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:GetCampaignDateRangeKpi', getCampaignDateRangeKpi_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:GetCampaignDateRangeKpi', getCampaignDateRangeKpi_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:GetCampaignDateRangeKpi', getCampaignDateRangeKpi_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:GetCampaignDateRangeKpi', getCampaignDateRangeKpi_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:applicationId:GetCampaignDateRangeKpi', getCampaignDateRangeKpi_applicationId - The unique identifier for the application. This identifier is displayed
as the Project ID on the Amazon Pinpoint console.
$sel:kpiName:GetCampaignDateRangeKpi', getCampaignDateRangeKpi_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.
$sel:campaignId:GetCampaignDateRangeKpi', getCampaignDateRangeKpi_campaignId - The unique identifier for the campaign.
Request Lenses
getCampaignDateRangeKpi_startTime :: Lens' GetCampaignDateRangeKpi (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.
getCampaignDateRangeKpi_nextToken :: Lens' GetCampaignDateRangeKpi (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.
getCampaignDateRangeKpi_endTime :: Lens' GetCampaignDateRangeKpi (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.
getCampaignDateRangeKpi_pageSize :: Lens' GetCampaignDateRangeKpi (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.
getCampaignDateRangeKpi_applicationId :: Lens' GetCampaignDateRangeKpi Text Source #
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
getCampaignDateRangeKpi_kpiName :: Lens' GetCampaignDateRangeKpi 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.
getCampaignDateRangeKpi_campaignId :: Lens' GetCampaignDateRangeKpi Text Source #
The unique identifier for the campaign.
Destructuring the Response
data GetCampaignDateRangeKpiResponse Source #
See: newGetCampaignDateRangeKpiResponse smart constructor.
Constructors
| GetCampaignDateRangeKpiResponse' | |
Fields
| |
Instances
newGetCampaignDateRangeKpiResponse Source #
Arguments
| :: Int | |
| -> CampaignDateRangeKpiResponse |
|
| -> GetCampaignDateRangeKpiResponse |
Create a value of GetCampaignDateRangeKpiResponse 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:GetCampaignDateRangeKpiResponse', getCampaignDateRangeKpiResponse_httpStatus - The response's http status code.
$sel:campaignDateRangeKpiResponse:GetCampaignDateRangeKpiResponse', getCampaignDateRangeKpiResponse_campaignDateRangeKpiResponse - Undocumented member.
Response Lenses
getCampaignDateRangeKpiResponse_httpStatus :: Lens' GetCampaignDateRangeKpiResponse Int Source #
The response's http status code.