Pemberitahuan akhir dukungan: Pada 30 Oktober 2026, AWS akan mengakhiri dukungan untuk Amazon Pinpoint. Setelah 30 Oktober 2026, Anda tidak akan lagi dapat mengakses konsol Amazon Pinpoint atau sumber daya Amazon Pinpoint (titik akhir, segmen, kampanye, perjalanan, dan analitik). Untuk informasi selengkapnya, lihat Amazon Pinpoint akhir dukungan. Catatan: APIs terkait dengan SMS, suara, push seluler, OTP, dan validasi nomor telepon tidak terpengaruh oleh perubahan ini dan didukung oleh AWS End User Messaging.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Kueri data Amazon Pinpoint untuk pesan email transaksional

Untuk menanyakan data pesan email transaksional yang dikirim untuk proyek, Anda menggunakan Application Metrics API dan menentukan nilai untuk parameter wajib berikut:

application-id — ID proyek, yang merupakan pengenal unik untuk proyek. Di Amazon Pinpoint, istilah proyek dan aplikasi memiliki arti yang sama.
kpi-name — Nama metrik untuk kueri. Nilai ini menggambarkan metrik terkait dan terdiri dari dua atau lebih istilah, yang terdiri dari karakter alfanumerik huruf kecil, dipisahkan oleh tanda hubung. Untuk daftar lengkap metrik yang didukung dan kpi-name nilai untuk masing-masing metrik, lihatMetrik standar untuk proyek, kampanye, dan perjalanan.

Anda juga dapat menerapkan filter yang menanyakan data untuk rentang tanggal tertentu. Jika Anda tidak menentukan rentang tanggal, Amazon Pinpoint mengembalikan data untuk 31 hari kalender sebelumnya. Untuk memfilter data berdasarkan tanggal yang berbeda, gunakan parameter rentang tanggal yang didukung untuk menentukan tanggal dan waktu pertama dan terakhir dari rentang tanggal. Nilai harus dalam format ISO 8601 yang diperluas dan menggunakan Coordinated Universal Time (UTC) —misalnya, 2019-09-06T20:00:00Z untuk 8:00 PM UTC 6 September 2019. Rentang tanggal bersifat inklusif dan harus dibatasi hingga 31 hari kalender atau lebih sedikit. Selain itu, tanggal dan waktu pertama harus kurang dari 90 hari dari hari ini.

Contoh berikut menunjukkan cara melakukan kueri data analitik untuk pesan email transaksional dengan menggunakan Amazon Pinpoint REST API, AWS CLI the, dan file. AWS SDK for Java Anda dapat menggunakan AWS SDK apa pun yang didukung untuk menanyakan data analitik untuk pesan transaksional. AWS CLI Contoh diformat untuk Microsoft Windows. Untuk Unix, Linux, dan macOS, ganti karakter line-continuation tanda sisipan (^) dengan garis miring terbalik (\).

REST API

Untuk melakukan kueri data analitik untuk pesan email transaksional menggunakan Amazon Pinpoint REST API, kirim permintaan HTTP (S) GET ke URI Metrik Aplikasi. Di URI, tentukan nilai yang sesuai untuk parameter jalur yang diperlukan:


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

Di mana:

endpointadalah titik akhir Amazon Pinpoint untuk AWS Wilayah yang menjadi tuan rumah proyek.
application-idadalah pengenal unik untuk proyek tersebut.
kpi-nameadalah kpi-name nilai untuk metrik untuk kueri.

Semua parameter harus dikodekan URL.

Untuk menerapkan filter yang menanyakan data untuk rentang tanggal tertentu, tambahkan parameter start-time dan nilai end-time kueri dan ke URI. Dengan menggunakan parameter ini, Anda dapat menentukan tanggal dan waktu pertama dan terakhir, dalam format ISO 8601 yang diperpanjang, dari rentang tanggal inklusif untuk mengambil data. Gunakan ampersand (&) untuk memisahkan parameter.

Misalnya, permintaan berikut mengambil jumlah pesan email transaksional yang dikirim untuk proyek dari 6 September 2019 hingga 13 September 2019:


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

Di mana:

pinpoint---us-east-1.amazonaws.com.rproxy.govskope.caadalah titik akhir Amazon Pinpoint untuk AWS Wilayah yang menjadi tuan rumah proyek.
1234567890123456789012345exampleadalah pengenal unik untuk proyek tersebut.
txn-emails-sentadalah kpi-name nilai untuk metrik aplikasi pengiriman, yang merupakan metrik yang melaporkan jumlah pesan email transaksional yang dikirim untuk suatu proyek.
2019-09-06T00:00:00Zadalah tanggal dan waktu pertama untuk mengambil data untuk, sebagai bagian dari rentang tanggal inklusif.
2019-09-13T23:59:59Zadalah tanggal dan waktu terakhir untuk mengambil data, sebagai bagian dari rentang tanggal inklusif.

AWS CLI

Untuk kueri data analitik untuk pesan email transaksional dengan menggunakan AWS CLI, gunakan get-application-date-range-kpi perintah, dan tentukan nilai yang sesuai untuk parameter yang diperlukan:


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

Di mana:

application-idadalah pengenal unik untuk proyek tersebut.
kpi-nameadalah kpi-name nilai untuk metrik untuk kueri.

Untuk menerapkan filter yang menanyakan data untuk rentang tanggal tertentu, tambahkan end-time parameter start-time dan nilai ke kueri Anda. Dengan menggunakan parameter ini, Anda dapat menentukan tanggal dan waktu pertama dan terakhir, dalam format ISO 8601 yang diperpanjang, dari rentang tanggal inklusif untuk mengambil data. Misalnya, permintaan berikut mengambil jumlah pesan email transaksional yang dikirim untuk proyek dari 6 September 2019 hingga 13 September 2019:


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

Di mana:

1234567890123456789012345exampleadalah pengenal unik untuk proyek tersebut.
txn-emails-sentadalah kpi-name nilai untuk metrik aplikasi pengiriman, yang merupakan metrik yang melaporkan jumlah pesan email transaksional yang dikirim untuk suatu proyek.
2019-09-06T00:00:00Zadalah tanggal dan waktu pertama untuk mengambil data untuk, sebagai bagian dari rentang tanggal inklusif.
2019-09-13T23:59:59Zadalah tanggal dan waktu terakhir untuk mengambil data, sebagai bagian dari rentang tanggal inklusif.

SDK for Java

Untuk melakukan kueri data analitik untuk pesan email transaksional dengan menggunakan AWS SDK for Java, gunakan GetApplicationDateRangeKpiRequest metode Application Metrics API. Tentukan nilai yang sesuai untuk parameter yang diperlukan:


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

Di mana:

applicationIdadalah pengenal unik untuk proyek tersebut.
kpiNameadalah kpi-name nilai untuk metrik untuk kueri.

Untuk menerapkan filter yang menanyakan data untuk rentang tanggal tertentu, sertakan endTime parameter startTime dan nilai dalam kueri Anda. Dengan menggunakan parameter ini, Anda dapat menentukan tanggal dan waktu pertama dan terakhir, dalam format ISO 8601 yang diperpanjang, dari rentang tanggal inklusif untuk mengambil data. Misalnya, permintaan berikut mengambil jumlah pesan email transaksional yang dikirim untuk proyek dari 6 September 2019 hingga 13 September 2019:


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")));

Di mana:

1234567890123456789012345exampleadalah pengenal unik untuk proyek tersebut.
txn-emails-sentadalah kpi-name nilai untuk metrik aplikasi pengiriman, yang merupakan metrik yang melaporkan jumlah pesan email transaksional yang dikirim untuk suatu proyek.
2019-09-06T00:00:00Zadalah tanggal dan waktu pertama untuk mengambil data untuk, sebagai bagian dari rentang tanggal inklusif.
2019-09-13T23:59:59Zadalah tanggal dan waktu terakhir untuk mengambil data, sebagai bagian dari rentang tanggal inklusif.

Setelah mengirim kueri, Amazon Pinpoint mengembalikan hasil kueri dalam respons JSON. Struktur hasil bervariasi tergantung pada metrik yang Anda kueri. Beberapa metrik hanya mengembalikan satu nilai. Misalnya, metrik aplikasi send (txn-emails-sent), yang digunakan dalam contoh sebelumnya, mengembalikan satu nilai—jumlah pesan email transaksional yang dikirim dari proyek. Dalam hal ini, respons JSON adalah sebagai berikut:


{
    "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"
    }
}

Metrik lain mengembalikan beberapa nilai dan mengelompokkan nilai berdasarkan bidang yang relevan. Jika metrik mengembalikan beberapa nilai, respons JSON menyertakan bidang yang menunjukkan bidang mana yang digunakan untuk mengelompokkan data.

Untuk mempelajari lebih lanjut tentang struktur hasil kueri, lihatGunakan hasil kueri JSON.

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Kueri data pesan transaksional

Data kueri untuk SMS transaksional