Interrogez les données Amazon Pinpoint pour les e-mails transactionnels - Amazon Pinpoint

Avis de fin de support : le 30 octobre 2026, le support d'Amazon Pinpoint AWS prendra fin. Après le 30 octobre 2026, vous ne pourrez plus accéder à la console Amazon Pinpoint ni aux ressources Amazon Pinpoint (points de terminaison, segments, campagnes, parcours et analytique). Pour plus d’informations, consultez Fin de la prise en charge d’Amazon Pinpoint. Remarque : en ce qui APIs concerne les SMS, la voix, le push mobile, l'OTP et la validation des numéros de téléphone ne sont pas concernés par cette modification et sont pris en charge par AWS la messagerie utilisateur final.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Interrogez les données Amazon Pinpoint pour les e-mails transactionnels

Pour interroger les données des messages électroniques transactionnels envoyés pour un projet, utilisez l'API Application Metrics et spécifiez les valeurs pour les paramètres requis suivants :

  • application-id : ID du projet, qui est l'identifiant unique du projet. Dans Amazon Pinpoint, les termes projet et application ont la même signification.

  • kpi-name : nom de la métrique à interroger. Cette valeur décrit la métrique associée et se compose de deux termes ou plus, composés de caractères alphanumériques minuscules, séparés par un trait d'union. Pour obtenir la liste complète des métriques prises en charge et la valeur kpi-name de chacune d'elles, reportez-vous à la section Mesures standard pour les projets, les campagnes et les parcours.

Vous pouvez également appliquer un filtre qui interroge les données pour une plage de dates spécifique. Si vous ne spécifiez pas de plage de dates, Amazon Pinpoint renvoie les données des 31 jours civils précédents. Pour filtrer les données selon différentes dates, utilisez les paramètres de plage de dates pris en charge pour spécifier les premières et dernières date et heure de la plage de dates. Les valeurs doivent être au format ISO 8601 étendu et utiliser le temps universel coordonné (UTC). Par exemple, 2019-09-06T20:00:00Z pour le 6 septembre 2019 à 20h00 UTC. Notez que les plages de dates sont inclusives et doivent être limitées à 31 jours calendaires au plus. En outre, les premières date et heure doivent être inférieures à 90 jours à compter du jour actuel.

Les exemples suivants montrent comment interroger des données d'analyse pour des e-mails transactionnels à l'aide de l'API REST Amazon Pinpoint, AWS CLI du, et du. AWS SDK pour Java Vous pouvez utiliser n'importe quel kit SDK AWS pris en charge pour interroger les données d'analyse pour les messages transactionnels. Les AWS CLI exemples sont formatés pour Microsoft Windows. Pour Unix, Linux et macOS, remplacez le caractère caret (^) de continuation de ligne par une barre oblique inverse (\).

REST API

Pour interroger les données analytiques des e-mails transactionnels à l'aide de l'API REST Amazon Pinpoint, envoyez une demande HTTP(S) GET à l'URI des Métriques d'application. Dans l'URI, spécifiez les valeurs appropriées pour les paramètres de chemin requis :

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

Où :

  • endpointest le point de terminaison Amazon Pinpoint pour la AWS région qui héberge le projet.

  • application-id est l'identifiant unique du projet.

  • kpi-nameest la kpi-name valeur de la métrique à interroger.

Tous les paramètres doivent être codés par URL.

Pour appliquer un filtre qui interroge les données pour une plage de dates spécifique, ajoutez les paramètres start-time et end-time et leurs valeurs à l'URI. À l'aide de ces paramètres, vous pouvez spécifier les premières et dernières date et l'heure, au format ISO 8601 étendu, d'une plage de dates incluse pour récupérer les données. Utilisez une esperluette (&) pour séparer les paramètres.

Par exemple, la demande suivante récupère le nombre de messages électroniques transactionnels envoyés pour un projet du 6 septembre 2019 au 13 septembre 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

Où :

  • pinpoint.us-east-1.amazonaws.com est le point de terminaison Amazon Pinpoint de la région AWS qui héberge le projet.

  • 1234567890123456789012345example est l'identifiant unique du projet.

  • txn-emails-sent est la valeur kpi-name de la métrique sends (envois) de l'application. Cette métrique indique le nombre de messages électroniques transactionnels envoyés pour un projet.

  • 2019-09-06T00:00:00Z est la première date et heure à laquelle récupérer les données, dans le cadre d'une plage de dates inclusive.

  • 2019-09-13T23:59:59Z est la dernière date et heure auxquelles récupérer les données, dans le cadre d'une plage de dates inclusive.

AWS CLI

Pour interroger les données d'analyse des e-mails transactionnels à l'aide de AWS CLI, utilisez la get-application-date-range-kpi commande et spécifiez les valeurs appropriées pour les paramètres requis :

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

Où :

  • application-id est l'identifiant unique du projet.

  • kpi-nameest la kpi-name valeur de la métrique à interroger.

Pour appliquer un filtre qui interroge les données pour une plage de dates spécifique, ajoutez les paramètres start-time etend-time et leurs valeurs à votre requête. À l'aide de ces paramètres, vous pouvez spécifier les premières et dernières date et l'heure, au format ISO 8601 étendu, d'une plage de dates incluse pour récupérer les données. Par exemple, la demande suivante récupère le nombre de messages électroniques transactionnels envoyés pour un projet du 6 septembre 2019 au 13 septembre 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

Où :

  • 1234567890123456789012345example est l'identifiant unique du projet.

  • txn-emails-sent est la valeur kpi-name de la métrique sends (envois) de l'application. Cette métrique indique le nombre de messages électroniques transactionnels envoyés pour un projet.

  • 2019-09-06T00:00:00Z est la première date et heure à laquelle récupérer les données, dans le cadre d'une plage de dates inclusive.

  • 2019-09-13T23:59:59Z est la dernière date et heure auxquelles récupérer les données, dans le cadre d'une plage de dates inclusive.

SDK for Java

Pour interroger les données d'analyse des e-mails transactionnels à l'aide de AWS SDK pour Java, utilisez la GetApplicationDateRangeKpiRequest méthode de l'API Application Metrics. Spécifiez les valeurs appropriées pour les paramètres requis :

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

Où :

  • applicationId est l'identifiant unique du projet.

  • kpiNameest la kpi-name valeur de la métrique à interroger.

Pour appliquer un filtre qui interroge les données pour une plage de dates spécifique, incluez les paramètres startTime etendTime et leurs valeurs dans votre requête. À l'aide de ces paramètres, vous pouvez spécifier les premières et dernières date et l'heure, au format ISO 8601 étendu, d'une plage de dates incluse pour récupérer les données. Par exemple, la demande suivante récupère le nombre de messages électroniques transactionnels envoyés pour un projet du 6 septembre 2019 au 13 septembre 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")));

Où :

  • 1234567890123456789012345example est l'identifiant unique du projet.

  • txn-emails-sent est la valeur kpi-name de la métrique sends (envois) de l'application. Cette métrique indique le nombre de messages électroniques transactionnels envoyés pour un projet.

  • 2019-09-06T00:00:00Z est la première date et heure à laquelle récupérer les données, dans le cadre d'une plage de dates inclusive.

  • 2019-09-13T23:59:59Z est la dernière date et heure auxquelles récupérer les données, dans le cadre d'une plage de dates inclusive.

Une fois que vous avez envoyé votre requête, Amazon Pinpoint renvoie les résultats de la requête dans une réponse JSON. La structure des résultats varie en fonction de la métrique que vous avez interrogée. Certaines mesures ne renvoient qu'une seule valeur. Par exemple, la métrique d'application envois (txn-emails-sent), utilisée dans les exemples précédents, renvoie une seule valeur : le nombre d'e-mails transactionnels envoyés à partir d'un projet. Dans ce cas, la réponse JSON est la suivante :

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

D'autres métriques renvoient plusieurs valeurs et regroupent les valeurs selon un champ pertinent. Si une mesure renvoie plusieurs valeurs, la réponse JSON inclut un champ qui indique quel champ a été utilisé pour regrouper les données.

Pour en savoir plus sur la structure des résultats de requête, reportez-vous à la section Utiliser les résultats des requêtes JSON.