Interroga i dati di Amazon Pinpoint per una campagna

Per eseguire una query sui dati di una campagna, è possibile utilizzare l'API Parametri della campagna e specificare i valori per i seguenti parametri richiesti:

• application-id: ID del progetto, ovvero l'identificatore univoco del progetto associato alla campagna. In Amazon Pinpoint, i termini progetto e applicazione hanno lo stesso significato.

• campaign-id: identificatore univoco della campagna.

• kpi-name: nome della metrica a cui inviare la query. Questo valore descrive il parametro associato ed è formato da due o più termini, che sono composti da caratteri alfanumerici minuscoli, separati da un trattino. Per un elenco completo dei parametri supportati e per il valore kpi-namedi ognuno, consulta Metriche standard per progetti, campagne e viaggi.

È inoltre possibile applicare un filtro che esegue le query sui dati di un intervallo di date specifico. Se non si specifica un intervallo di date, Amazon Pinpoint restituisce i dati dei 31 giorni di calendario precedenti. Per filtrare i dati in base a date diverse, utilizzare i parametri dell'intervallo di date supportati per specificare la prima e l'ultima data e l'ora dell'intervallo di date. I valori devono essere in formato ISO 8601 esteso e utilizzare il fuso orario UTC (Coordinated Universal Time), ad esempio 2019-07-19T20:00:00Z per le 20:00 UTC del 19 luglio 2019. Gli intervalli di date includono gli estremi e devono essere limitati a 31 o a un numero minore di giorni di calendario. Inoltre, la prima data e la prima ora non devono precedere il giorno corrente di più di 90 giorni.

Gli esempi seguenti mostrano come interrogare i dati di analisi per una campagna utilizzando l'API REST di Amazon Pinpoint AWS CLI, il e il. AWS SDK per Java Puoi utilizzare qualsiasi AWS SDK supportato per interrogare i dati di analisi per una campagna. Gli AWS CLI esempi sono formattati per Microsoft Windows. Per Unix, Linux e macOS, sostituire il carattere di continuazione della riga caret (^) con una barra rovesciata ().

REST API

Per eseguire query sui dati di analisi per una campagna tramite la REST API Amazon Pinpoint, invia una richiesta HTTP(S) GET all'URI Parametri della campagna. Nell'URI, specificare i valori appropriati per i parametri del percorso richiesti:

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

Dove:

• endpointè l'endpoint Amazon Pinpoint per la AWS regione che ospita il progetto associato alla campagna.

• application-id è l'identificatore univoco del progetto associato alla campagna.

• campaign-id è l'identificatore univoco per la campagna.

• kpi-nameè il kpi-name valore della metrica da interrogare.

Tutti i parametri devono essere codificati URL.

Per applicare un filtro che interroga i dati per un intervallo di date specifico, aggiungere i parametri di query e i valori start-time e end-time all'URI. Utilizzando questi parametri, è possibile specificare la prima e l'ultima data e l'ora, in formato ISO 8601 esteso, di un intervallo di date inclusivo per il recupero dei dati. Utilizzare una e commerciale (&) per separare i parametri.

Ad esempio, la richiesta seguente recupera il numero di endpoint univoci a cui sono stati recapitati i messaggi, da tutte le esecuzioni di una campagna, dal 19 luglio 2019 al 26 luglio 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

Dove:

• pinpoint.us-east-1.amazonaws.com è l'endpoint Amazon Pinpoint per la regione AWS che ospita il progetto.

• 1234567890123456789012345example è l'identificatore univoco del progetto associato alla campagna.

• 80b8efd84042ff8d9c96ce2f8example è l'identificatore univoco per la campagna.

• unique-deliveries è il valore kpi-name del parametro della campagna recapiti endpoint, ovvero il parametro che segnala il numero di endpoint univoci a cui sono stati recapitati i messaggi, da tutti i cicli di una campagna.

• 2019-07-19T00:00:00Z rappresenta la prima data e ora per il recupero dei dati, come parte di un intervallo di date inclusivo.

• 2019-07-26T23:59:59Z rappresenta l'ultima data e l'ora in cui recuperare i dati, come parte di un intervallo di date inclusivo.

AWS CLI

Per interrogare i dati di analisi per una campagna utilizzando il AWS CLI, utilizza il get-campaign-date-range-kpi comando e specifica i valori appropriati per i parametri richiesti:

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

Dove:

• application-id è l'identificatore univoco del progetto associato alla campagna.

• campaign-id è l'identificatore univoco per la campagna.

• kpi-nameè il kpi-name valore della metrica da interrogare.

Per applicare un filtro che interroga i dati per un intervallo di date specifico, aggiungere i parametri e i valori end-time e start-time alla query. Utilizzando questi parametri, è possibile specificare la prima e l'ultima data e l'ora, in formato ISO 8601 esteso, di un intervallo di date inclusivo per il recupero dei dati. Ad esempio, la richiesta seguente recupera il numero di endpoint univoci a cui sono stati recapitati i messaggi, da tutte le esecuzioni di una campagna, dal 19 luglio 2019 al 26 luglio 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

Dove:

• 1234567890123456789012345example è l'identificatore univoco del progetto associato alla campagna.

• 80b8efd84042ff8d9c96ce2f8example è l'identificatore univoco per la campagna.

• unique-deliveries è il valore kpi-name del parametro della campagna recapiti endpoint, ovvero il parametro che segnala il numero di endpoint univoci a cui sono stati recapitati i messaggi, da tutti i cicli di una campagna.

• 2019-07-19T00:00:00Z rappresenta la prima data e ora per il recupero dei dati, come parte di un intervallo di date inclusivo.

• 2019-07-26T23:59:59Z rappresenta l'ultima data e l'ora in cui recuperare i dati, come parte di un intervallo di date inclusivo.

SDK for Java

Per interrogare i dati di analisi per una campagna utilizzando AWS SDK per Java, utilizza il GetCampaignDateRangeKpiRequest metodo dell'API Campaign Metrics. Specificare i valori appropriati per i parametri richiesti:

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

Dove:

• applicationId è l'identificatore univoco del progetto associato alla campagna.

• campaignId è l'identificatore univoco per la campagna.

• kpiNameè il kpi-name valore della metrica da interrogare.

Per applicare un filtro che interroga i dati per un intervallo di date specifico, includere i parametri e i valori endTime e startTime alla query. Utilizzando questi parametri, è possibile specificare la prima e l'ultima data e l'ora, in formato ISO 8601 esteso, di un intervallo di date inclusivo per il recupero dei dati. Ad esempio, la richiesta seguente recupera il numero di endpoint univoci a cui sono stati recapitati i messaggi, da tutte le esecuzioni di una campagna, dal 19 luglio 2019 al 26 luglio 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")));

Dove:

• 1234567890123456789012345example è l'identificatore univoco del progetto associato alla campagna.

• 80b8efd84042ff8d9c96ce2f8example è l'identificatore univoco per la campagna.

• unique-deliveries è il valore kpi-name del parametro della campagna recapiti endpoint, ovvero il parametro che segnala il numero di endpoint univoci a cui sono stati recapitati i messaggi, da tutti i cicli di una campagna.

• 2019-07-19T00:00:00Z rappresenta la prima data e ora per il recupero dei dati, come parte di un intervallo di date inclusivo.

• 2019-07-26T23:59:59Z rappresenta l'ultima data e l'ora in cui recuperare i dati, come parte di un intervallo di date inclusivo.

Dopo aver inviato la query, Amazon Pinpoint restituisce i risultati della query in una risposta JSON. La struttura dei risultati varia a seconda del parametro interrogato. Alcuni parametri restituiscono un solo valore. Ad esempio, la metrica della campagna Recapiti agli endpoint (unique-deliveries), utilizzata negli esempi precedenti, restituisce un valore, ovvero il numero di endpoint univoci a cui sono stati recapitati i messaggi, per tutte le esecuzioni di una campagna. In questo caso, la risposta JSON è la seguente:

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

Altri parametri restituiscono più valori e raggruppano tali valori in base a un campo pertinente. Se un parametro restituisce più valori, la risposta JSON include un campo che indica quale campo è stato utilizzato per raggruppare i dati.

Per ulteriori informazioni sulla struttura dei risultati delle query, consulta Usa i risultati delle query JSON.