Kueri data Amazon Pinpoint untuk satu kampanye

Untuk melakukan kueri data untuk satu kampanye, Anda menggunakan API Metrik Kampanye dan menentukan nilai untuk parameter wajib berikut:

• application-id — ID proyek, yang merupakan pengenal unik untuk proyek yang terkait dengan kampanye. Di Amazon Pinpoint, istilah proyek dan aplikasi memiliki arti yang sama.

• campaign-id — Pengenal unik untuk kampanye.

• 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-07-19T20:00:00Z untuk 8:00 PM UTC 19 Juli 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 kampanye menggunakan Amazon Pinpoint REST API, the AWS CLI, dan. AWS SDK untuk Java Anda dapat menggunakan AWS SDK apa pun yang didukung untuk menanyakan data analitik untuk kampanye. 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 menanyakan data analitik kampanye menggunakan Amazon Pinpoint REST API, kirim permintaan HTTP (S) GET ke URI Metrik Kampanye. Di URI, tentukan nilai yang sesuai untuk parameter jalur yang diperlukan:

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

Di mana:

• endpointadalah titik akhir Amazon Pinpoint untuk AWS Wilayah yang menjadi tuan rumah proyek yang terkait dengan kampanye.

• application-idadalah pengenal unik untuk proyek yang terkait dengan kampanye.

• campaign-idadalah pengenal unik untuk kampanye.

• 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 titik akhir unik yang dikirimkan pesan, oleh semua proses kampanye, dari 19 Juli 2019 hingga 26 Juli 2019:

https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/campaigns/80b8efd84042ff8d9c96ce2f8example/kpis/daterange/unique-deliveries?start-time=2019-07-19T00:00:00Z&end-time=2019-07-26T23:59:59Z

Di mana:

• pinpoint.us-east-1.amazonaws.comadalah titik akhir Amazon Pinpoint untuk AWS Wilayah yang menjadi tuan rumah proyek.

• 1234567890123456789012345exampleadalah pengenal unik untuk proyek yang terkait dengan kampanye.

• 80b8efd84042ff8d9c96ce2f8exampleadalah pengenal unik untuk kampanye.

• unique-deliveriesadalah kpi-name nilai untuk metrik kampanye pengiriman titik akhir, yang merupakan metrik yang melaporkan jumlah titik akhir unik yang dikirimkan pesan, oleh semua proses kampanye.

• 2019-07-19T00:00:00Zadalah tanggal dan waktu pertama untuk mengambil data untuk, sebagai bagian dari rentang tanggal inklusif.

• 2019-07-26T23:59:59Zadalah tanggal dan waktu terakhir untuk mengambil data, sebagai bagian dari rentang tanggal inklusif.

AWS CLI

Untuk melakukan kueri data analitik untuk kampanye dengan menggunakan AWS CLI, gunakan get-campaign-date-range-kpi perintah dan tentukan nilai yang sesuai untuk parameter yang diperlukan:

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

Di mana:

• application-idadalah pengenal unik untuk proyek yang terkait dengan kampanye.

• campaign-idadalah pengenal unik untuk kampanye.

• 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 titik akhir unik yang dikirimkan pesan, oleh semua proses kampanye, dari 19 Juli 2019 hingga 26 Juli 2019:

C:\> aws pinpoint get-campaign-date-range-kpi ^
    --application-id 1234567890123456789012345example ^
    --campaign-id 80b8efd84042ff8d9c96ce2f8example ^
    --kpi-name unique-deliveries ^
    --start-time 2019-07-19T00:00:00Z ^
    --end-time 2019-07-26T23:59:59Z

Di mana:

• 1234567890123456789012345exampleadalah pengenal unik untuk proyek yang terkait dengan kampanye.

• 80b8efd84042ff8d9c96ce2f8exampleadalah pengenal unik untuk kampanye.

• unique-deliveriesadalah kpi-name nilai untuk metrik kampanye pengiriman titik akhir, yang merupakan metrik yang melaporkan jumlah titik akhir unik yang dikirimkan pesan, oleh semua proses kampanye.

• 2019-07-19T00:00:00Zadalah tanggal dan waktu pertama untuk mengambil data untuk, sebagai bagian dari rentang tanggal inklusif.

• 2019-07-26T23:59:59Zadalah tanggal dan waktu terakhir untuk mengambil data, sebagai bagian dari rentang tanggal inklusif.

SDK for Java

Untuk melakukan kueri data analitik untuk kampanye menggunakan AWS SDK untuk Java, gunakan GetCampaignDateRangeKpiRequest metode API Metrik Kampanye. Tentukan nilai yang sesuai untuk parameter yang diperlukan:

GetCampaignDateRangeKpiRequest request = new GetCampaignDateRangeKpiRequest()
        .withApplicationId("applicationId")
        .withCampaignId("campaignId")
        .withKpiName("kpiName")

Di mana:

• applicationIdadalah pengenal unik untuk proyek yang terkait dengan kampanye.

• campaignIdadalah pengenal unik untuk kampanye.

• 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 titik akhir unik yang dikirimkan pesan, oleh semua proses kampanye, dari 19 Juli 2019 hingga 26 Juli 2019:

GetCampaignDateRangeKpiRequest request = new GetCampaignDateRangeKpiRequest()
        .withApplicationId("1234567890123456789012345example")
        .withCampaignId("80b8efd84042ff8d9c96ce2f8example")
        .withKpiName("unique-deliveries")
        .withStartTime(Date.from(Instant.parse("2019-07-19T00:00:00Z")))
        .withEndTime(Date.from(Instant.parse("2019-07-26T23:59:59Z")));

Di mana:

• 1234567890123456789012345exampleadalah pengenal unik untuk proyek yang terkait dengan kampanye.

• 80b8efd84042ff8d9c96ce2f8exampleadalah pengenal unik untuk kampanye.

• unique-deliveriesadalah kpi-name nilai untuk metrik kampanye pengiriman titik akhir, yang merupakan metrik yang melaporkan jumlah titik akhir unik yang dikirimkan pesan, oleh semua proses kampanye.

• 2019-07-19T00:00:00Zadalah tanggal dan waktu pertama untuk mengambil data untuk, sebagai bagian dari rentang tanggal inklusif.

• 2019-07-26T23: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 kampanye endpoint deliveries (unique-deliveries), yang digunakan dalam contoh sebelumnya, mengembalikan satu nilai—jumlah titik akhir unik yang dikirimkan pesan, oleh semua proses kampanye. Dalam hal ini, respons JSON adalah sebagai berikut:

{
    "CampaignDateRangeKpiResponse":{
        "ApplicationId":"1234567890123456789012345example",
        "CampaignId":"80b8efd84042ff8d9c96ce2f8example",
        "EndTime":"2019-07-26T23:59:59Z",
        "KpiName":"unique-deliveries",
        "KpiResult":{
            "Rows":[
                {
                    "Values":[
                        {
                            "Key":"UniqueDeliveries",
                            "Type":"Double",
                            "Value":"123.0"
                        }
                    ]
                }
            ]
        },
        "StartTime":"2019-07-19T00: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.