查询事务性电子邮件消息的 Amazon Pinpoint 数据

聚焦模式

查询事务性电子邮件消息的 Amazon Pinpoint 数据 - Amazon Pinpoint

要查询为项目发送的事务性电子邮件消息的数据，请使用应用程序指标 API 并指定以下所需参数的值：

application-id – 项目 ID，它是项目的唯一标识符。在 Amazon Pinpoint 中，项目和应用程序 具有相同的含义。
kpi-name – 要查询的指标的名称。此值描述了关联的指标并包含两个或两个以上的术语，这些术语由小写字母数字字符组成并由连字符分隔。有关受支持的指标及其 kpi-name 值的完整列表，请参阅项目、活动和旅程的标准指标。

您也可以应用筛选器来查询特定日期范围的数据。如果未指定日期范围，则 Amazon Pinpoint 返回前 31 个日历日期间的数据。要按不同的日期筛选数据，请使用支持的日期范围参数指定日期范围的起始和截止日期和时间。这些值应采用扩展的 ISO 8601 格式，并使用协调世界时 (UTC)，例如，2019-09-06T20:00:00Z 表示协调世界时 2019 年 9 月 6 日晚上 8 点。日期范围是包含性的，必须限制为不超过 31 个日历天。此外，起始日期和时间必须距离当前日期不到 90 天。

以下示例演示了如何使用 Amazon Pinpoint REST API、AWS CLI 和 AWS SDK for Java 查询事务性电子邮件消息的分析数据。您可以使用任何受支持的 AWS SDK 查询事务性消息的分析数据。AWS CLI 示例的格式适用于 Microsoft Windows。对于 Unix、Linux 和 macOS，请将插入符号 (^) 行继续符替换为反斜杠 (\)。

REST API

要使用 Amazon Pinpoint REST API 查询事务性电子邮件消息的分析数据，请向应用程序指标 URI 发送 HTTP(S) GET 请求。在此 URI 中，为所需的路径参数指定适当的值：


https://endpoint/v1/apps/application-id/kpis/daterange/kpi-name

其中：

endpoint 是托管项目的 AWS 区域的 Amazon Pinpoint 端点。
application-id 是项目的唯一标识符。
kpi-name 是要查询的指标的 kpi-name 值。

所有参数都应是 URL 编码的。

要应用一个筛选器来查询特定日期范围的数据，请将 start-time 和 end-time 查询参数和值附加到 URI。通过使用这些参数，您可采用扩展的 ISO 8601 格式，指定检索数据的包含性日期范围的起始和截止日期和时间。使用 & 符号分隔参数。

例如，以下请求会检索在 2019 年 9 月 6 日到 2019 年 9 月 13 日期间为项目发送的事务性电子邮件消息的数量：


https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/txn-emails-sent?start-time=2019-09-06T00:00:00Z&end-time=2019-09-13T23:59:59Z

其中：

pinpoint.us-east-1.amazonaws.com 是托管项目的 AWS 区域的 Amazon Pinpoint 端点。
1234567890123456789012345example 是项目的唯一标识符。
txn-emails-sent 是发送数应用程序指标的 kpi-name 值，该指标用于报告为项目发送的事务性电子邮件消息的数量。
2019-09-06T00:00:00Z 是数据检索范围的第一个日期和时间（包含在检索日期范围内）。
2019-09-13T23:59:59Z 是检索数据的截止日期和时间，也是包含性日期范围的一部分。

AWS CLI

要使用 AWS CLI 查询事务性电子邮件消息的分析数据，请使用 get-application-date-range-kpi 命令并为所需的参数指定相应的值：


C:\> aws pinpoint get-application-date-range-kpi ^
    --application-id application-id ^
    --kpi-name kpi-name

其中：

application-id 是项目的唯一标识符。
kpi-name 是要查询的指标的 kpi-name 值。

要应用一个筛选器来查询特定日期范围的数据，请将 start-time 和 end-time 参数和值添加到您的查询。通过使用这些参数，您可采用扩展的 ISO 8601 格式，指定检索数据的包含性日期范围的起始和截止日期和时间。例如，以下请求会检索在 2019 年 9 月 6 日到 2019 年 9 月 13 日期间为项目发送的事务性电子邮件消息的数量：


C:\> aws pinpoint get-application-date-range-kpi ^
    --application-id 1234567890123456789012345example ^
    --kpi-name txn-emails-sent ^
    --start-time 2019-09-06T00:00:00Z ^
    --end-time 2019-09-13T23:59:59Z

其中：

1234567890123456789012345example 是项目的唯一标识符。
txn-emails-sent 是发送数应用程序指标的 kpi-name 值，该指标用于报告为项目发送的事务性电子邮件消息的数量。
2019-09-06T00:00:00Z 是数据检索范围的第一个日期和时间（包含在检索日期范围内）。
2019-09-13T23:59:59Z 是检索数据的截止日期和时间，也是包含性日期范围的一部分。

SDK for Java

要使用 AWS SDK for Java 查询事务性电子邮件消息的分析数据，请使用应用程序指标 API 的 GetApplicationDateRangeKpiRequest 方法。为所需的参数指定相应的值：


GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest()
        .withApplicationId("applicationId")
        .withKpiName("kpiName")

其中：

applicationId 是项目的唯一标识符。
kpiName 是要查询的指标的 kpi-name 值。

要应用一个筛选器来查询特定日期范围的数据，请将 startTime 和 endTime 参数和值包含在您的查询中。通过使用这些参数，您可采用扩展的 ISO 8601 格式，指定检索数据的包含性日期范围的起始和截止日期和时间。例如，以下请求会检索在 2019 年 9 月 6 日到 2019 年 9 月 13 日期间为项目发送的事务性电子邮件消息的数量：


GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest()
        .withApplicationId("1234567890123456789012345example")
        .withKpiName("txn-emails-sent")
        .withStartTime(Date.from(Instant.parse("2019-09-06T00:00:00Z")))
        .withEndTime(Date.from(Instant.parse("2019-09-13T23:59:59Z")));

其中：

1234567890123456789012345example 是项目的唯一标识符。
txn-emails-sent 是发送数应用程序指标的 kpi-name 值，该指标用于报告为项目发送的事务性电子邮件消息的数量。
2019-09-06T00:00:00Z 是数据检索范围的第一个日期和时间（包含在检索日期范围内）。
2019-09-13T23:59:59Z 是检索数据的截止日期和时间，也是包含性日期范围的一部分。

anchor anchor anchor


https://endpoint/v1/apps/application-id/kpis/daterange/kpi-name

其中：

endpoint 是托管项目的 AWS 区域的 Amazon Pinpoint 端点。
application-id 是项目的唯一标识符。
kpi-name 是要查询的指标的 kpi-name 值。

所有参数都应是 URL 编码的。

例如，以下请求会检索在 2019 年 9 月 6 日到 2019 年 9 月 13 日期间为项目发送的事务性电子邮件消息的数量：


https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/txn-emails-sent?start-time=2019-09-06T00:00:00Z&end-time=2019-09-13T23:59:59Z

其中：

pinpoint.us-east-1.amazonaws.com 是托管项目的 AWS 区域的 Amazon Pinpoint 端点。
1234567890123456789012345example 是项目的唯一标识符。
txn-emails-sent 是发送数应用程序指标的 kpi-name 值，该指标用于报告为项目发送的事务性电子邮件消息的数量。
2019-09-06T00:00:00Z 是数据检索范围的第一个日期和时间（包含在检索日期范围内）。
2019-09-13T23:59:59Z 是检索数据的截止日期和时间，也是包含性日期范围的一部分。

发送查询后，Amazon Pinpoint 在 JSON 响应中返回查询结果。结果的结构因您查询的指标而异。一些指标仅返回一个值。例如，上述示例中使用的发送数 (txn-emails-sent) 应用程序指标返回一个值，即从项目发送的事务性电子邮件消息的数量。在这种情况下，JSON 响应如下所示：


{
    "ApplicationDateRangeKpiResponse":{
        "ApplicationId":"1234567890123456789012345example",
        "EndTime":"2019-09-13T23:59:59Z",
        "KpiName":"txn-emails-sent",
        "KpiResult":{
            "Rows":[
                {
                    "Values":[
                        {
                            "Key":"TxnEmailsSent",
                            "Type":"Double",
                            "Value":"62.0"
                        }
                    ]
                }
            ]
        },
        "StartTime":"2019-09-06T00:00:00Z"
    }
}

另一些指标返回多个值，并按相关字段对这些值进行分组。如果指标返回多个值，则 JSON 响应将包含一个字段，该字段指示对数据进行分组时所用的字段。

要了解有关查询结果结构的更多信息，请参阅使用 JSON 查询结果。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

查询事务性消息数据

查询事务性短信的数据

选择您的 Cookie 首选项

自定义 Cookie 首选项

关键

性能

功能

广告

无法保存 Cookie 首选项

查询事务性电子邮件消息的 Amazon Pinpoint 数据

此页内容对您是否有帮助？

下一主题：

上一主题：

需要帮助吗？