Interroga i dati di Amazon Pinpoint per i messaggi SMS transazionali - Amazon Pinpoint

Avviso di fine del supporto: il 30 ottobre 2026 AWS terminerà il supporto per Amazon Pinpoint. Dopo il 30 ottobre 2026, non potrai più accedere alla console Amazon Pinpoint o alle risorse Amazon Pinpoint (endpoint, segmenti, campagne, percorsi e analisi). Per ulteriori informazioni, consulta Fine del supporto di Amazon Pinpoint. Nota: per quanto APIs riguarda gli SMS, i comandi vocali, i messaggi push su dispositivi mobili, l'OTP e la convalida del numero di telefono non sono interessati da questa modifica e sono supportati da End User Messaging. AWS

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Interroga i dati di Amazon Pinpoint per i messaggi SMS transazionali

Per eseguire una query sui dati relativi ai messaggi SMS transazionali inviati per un progetto, è possibile utilizzare l'API Parametri applicazioni e specificare i valori per i seguenti parametri richiesti:

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

  • 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-09-06T20:00:00Z per le 20:00 UTC del 6 settembre 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 i messaggi SMS transazionali utilizzando l'API REST di Amazon Pinpoint, il e AWS CLI il. AWS SDK per Java Puoi utilizzare qualsiasi AWS SDK supportato per interrogare i dati di analisi per i messaggi transazionali. 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 i messaggi SMS transazionali tramite la REST API Amazon Pinpoint, invia una richiesta HTTP(S) GET all'URI Metriche delle applicazioni. Nell'URI, specificare i valori appropriati per i parametri del percorso richiesti:

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

Dove:

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

  • application-id è l'identificatore univoco per il progetto.

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

Tutti i parametri devono essere codificati URL.

Per applicare un filtro che richiama 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 seguente richiesta recupera il numero di messaggi SMS transazionali inviati ogni giorno dal 6 settembre 2019 all'8 settembre 2019:

https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/txn-sms-sent-grouped-by-date?start-time=2019-09-06T00:00:00Z&end-time=2019-09-08T23: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 per il progetto.

  • txn-sms-sent-grouped-by-date è il valore kpi-name del parametro dell'applicazione invii, raggruppati per data ovvero il parametro che restituisce il numero di messaggi SMS transazionali inviati ogni giorno nell'intervallo di date indicato.

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

  • 2019-09-08T23: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 i messaggi SMS transazionali utilizzando il AWS CLI, utilizzate il get-application-date-range-kpi comando e specificate i valori appropriati per i parametri richiesti:

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

Dove:

  • application-id è l'identificatore univoco per il progetto.

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

Per applicare un filtro che richiama i dati per un intervallo di date specifico, includere 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 seguente richiesta recupera il numero di messaggi SMS transazionali inviati ogni giorno dal 6 settembre 2019 all'8 settembre 2019:

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

Dove:

  • 1234567890123456789012345example è l'identificatore univoco per il progetto.

  • txn-sms-sent-grouped-by-date è il valore kpi-name del parametro dell'applicazione invii, raggruppati per data ovvero il parametro che restituisce il numero di messaggi SMS transazionali inviati ogni giorno nell'intervallo di date indicato.

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

  • 2019-09-08T23: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 i messaggi SMS transazionali utilizzando il AWS SDK per Java, utilizza il GetApplicationDateRangeKpiRequest metodo dell'API Application Metrics e specifica i valori appropriati per i parametri richiesti:

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

Dove:

  • applicationId è l'identificatore univoco per il progetto.

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

Per applicare un filtro che richiama 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 seguente richiesta recupera il numero di messaggi SMS transazionali inviati ogni giorno dal 6 settembre 2019 all'8 settembre 2019:

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

Dove:

  • 1234567890123456789012345example è l'identificatore univoco per il progetto.

  • txn-sms-sent-grouped-by-date è il valore kpi-name del parametro dell'applicazione invii, raggruppati per data ovvero il parametro che restituisce il numero di messaggi SMS transazionali inviati ogni giorno nell'intervallo di date indicato.

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

  • 2019-09-08T23: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. 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.

Ad esempio, la metrica Invii, raggruppati per data (txn-sms-sent-grouped-by-date), utilizzata negli esempi precedenti, restituisce più valori, ovvero il numero di messaggi SMS transazionali inviati durante ogni giorno dell'intervallo di date specificato. In questo caso, la risposta JSON è la seguente:

{ "ApplicationDateRangeKpiResponse":{ "ApplicationId":"1234567890123456789012345example", "EndTime":"2019-09-08T23:59:59Z", "KpiName":"txn-sms-sent-grouped-by-date", "KpiResult":{ "Rows":[ { "GroupedBys":[ { "Key":"Date", "Type":"String", "Value":"2019-09-06" } ], "Values":[ { "Key":"TxnSmsSent", "Type":"Double", "Value":"29.0" } ] }, { "GroupedBys":[ { "Key":"Date", "Type":"String", "Value":"2019-09-07" } ], "Values":[ { "Key":"TxnSmsSent", "Type":"Double", "Value":"35.0" } ] }, { "GroupedBys":[ { "Key":"Date", "Type":"String", "Value":"2019-09-08" } ], "Values":[ { "Key":"TxnSmsSent", "Type":"Double", "Value":"10.0" } ] } ] }, "StartTime":"2019-09-06T00:00:00Z" } }

In questo caso, il campo GroupedBys indica che i valori sono raggruppati per giorno di calendario (Date). Ciò significa che:

  • 29 messaggi sono stati inviati il 6 settembre 2019.

  • 35 messaggi sono stati inviati il 7 settembre 2019.

  • 10 messaggi sono stati inviati l'8 settembre 2019.

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