查詢交易電子郵件訊息的 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 UTC 月 6 日晚上 8：00。日期範圍包含在內，且必須不超過 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，請將 HTTP（S） GET請求傳送至應用程式指標 URI。在中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，請使用 Application Metrics GetApplicationDateRangeKpiRequest的方法API。為所需參數指定適當的值：


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

若要使用 Amazon Pinpoint REST 查詢交易電子郵件訊息的分析資料API，請將 HTTP（S） GET請求傳送至應用程式指標 URI。在中URI，指定所需路徑參數的適當值：


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。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

查詢交易訊息資料

交易查詢資料 SMS

選取您的 Cookie 偏好設定

自訂 Cookie 偏好設定

必要

效能

功能

廣告

無法儲存 Cookie 偏好設定

查詢交易電子郵件訊息的 Amazon Pinpoint 資料

此頁面是否有幫助？

下一個主題：

上一個主題：

需要協助？