Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieve inbox placement and engagement rates for the domains that you use to send email.
Synopsis
- data GetDomainStatisticsReport = GetDomainStatisticsReport' {}
- newGetDomainStatisticsReport :: Text -> UTCTime -> UTCTime -> GetDomainStatisticsReport
- getDomainStatisticsReport_domain :: Lens' GetDomainStatisticsReport Text
- getDomainStatisticsReport_startDate :: Lens' GetDomainStatisticsReport UTCTime
- getDomainStatisticsReport_endDate :: Lens' GetDomainStatisticsReport UTCTime
- data GetDomainStatisticsReportResponse = GetDomainStatisticsReportResponse' {}
- newGetDomainStatisticsReportResponse :: Int -> OverallVolume -> GetDomainStatisticsReportResponse
- getDomainStatisticsReportResponse_httpStatus :: Lens' GetDomainStatisticsReportResponse Int
- getDomainStatisticsReportResponse_overallVolume :: Lens' GetDomainStatisticsReportResponse OverallVolume
- getDomainStatisticsReportResponse_dailyVolumes :: Lens' GetDomainStatisticsReportResponse [DailyVolume]
Creating a Request
data GetDomainStatisticsReport Source #
A request to obtain deliverability metrics for a domain.
See: newGetDomainStatisticsReport
smart constructor.
GetDomainStatisticsReport' | |
|
Instances
newGetDomainStatisticsReport Source #
:: Text | |
-> UTCTime | |
-> UTCTime | |
-> GetDomainStatisticsReport |
Create a value of GetDomainStatisticsReport
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:
GetDomainStatisticsReport
, getDomainStatisticsReport_domain
- The domain that you want to obtain deliverability metrics for.
GetDomainStatisticsReport
, getDomainStatisticsReport_startDate
- The first day (in Unix time) that you want to obtain domain
deliverability metrics for.
GetDomainStatisticsReport
, getDomainStatisticsReport_endDate
- The last day (in Unix time) that you want to obtain domain
deliverability metrics for. The EndDate
that you specify has to be
less than or equal to 30 days after the StartDate
.
Request Lenses
getDomainStatisticsReport_domain :: Lens' GetDomainStatisticsReport Text Source #
The domain that you want to obtain deliverability metrics for.
getDomainStatisticsReport_startDate :: Lens' GetDomainStatisticsReport UTCTime Source #
The first day (in Unix time) that you want to obtain domain deliverability metrics for.
getDomainStatisticsReport_endDate :: Lens' GetDomainStatisticsReport UTCTime Source #
The last day (in Unix time) that you want to obtain domain
deliverability metrics for. The EndDate
that you specify has to be
less than or equal to 30 days after the StartDate
.
Destructuring the Response
data GetDomainStatisticsReportResponse Source #
An object that includes statistics that are related to the domain that you specified.
See: newGetDomainStatisticsReportResponse
smart constructor.
GetDomainStatisticsReportResponse' | |
|
Instances
newGetDomainStatisticsReportResponse Source #
Create a value of GetDomainStatisticsReportResponse
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:GetDomainStatisticsReportResponse'
, getDomainStatisticsReportResponse_httpStatus
- The response's http status code.
$sel:overallVolume:GetDomainStatisticsReportResponse'
, getDomainStatisticsReportResponse_overallVolume
- An object that contains deliverability metrics for the domain that you
specified. The data in this object is a summary of all of the data that
was collected from the StartDate
to the EndDate
.
$sel:dailyVolumes:GetDomainStatisticsReportResponse'
, getDomainStatisticsReportResponse_dailyVolumes
- An object that contains deliverability metrics for the domain that you
specified. This object contains data for each day, starting on the
StartDate
and ending on the EndDate
.
Response Lenses
getDomainStatisticsReportResponse_httpStatus :: Lens' GetDomainStatisticsReportResponse Int Source #
The response's http status code.
getDomainStatisticsReportResponse_overallVolume :: Lens' GetDomainStatisticsReportResponse OverallVolume Source #
An object that contains deliverability metrics for the domain that you
specified. The data in this object is a summary of all of the data that
was collected from the StartDate
to the EndDate
.
getDomainStatisticsReportResponse_dailyVolumes :: Lens' GetDomainStatisticsReportResponse [DailyVolume] Source #
An object that contains deliverability metrics for the domain that you
specified. This object contains data for each day, starting on the
StartDate
and ending on the EndDate
.