Interrogez les données Amazon Pinpoint pour une campagne

Pour interroger les données d'une campagne, utilisez l'API Métriques de campagne et spécifiez les valeurs des paramètres requis suivants :

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

• campaign-id : identifiant unique de la campagne.

• 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-07-19T20:00:00Z pour 20h00 UTC le 19 juillet 2019. 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 une campagne à l'aide de l'API REST Amazon Pinpoint, du AWS CLI, et du. AWS SDK pour Java Vous pouvez utiliser n'importe quel AWS SDK compatible pour interroger les données d'analyse d'une campagne. 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 d'une campagne à l'aide de l'API REST Amazon Pinpoint, envoyez une demande HTTP(S) GET à l'URI des métriques de campagne. Dans l'URI, spécifiez les valeurs appropriées pour les paramètres de chemin requis :

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

Où :

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

• application-id est l'identifiant unique du projet associé à la campagne.

• campaign-id est l'identifiant unique de la campagne.

• 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 extrait le nombre de points de terminaison uniques auxquels les messages ont été remis, par toutes les exécutions d'une campagne, du 19 juillet 2019 au 26 juillet 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

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 associé à la campagne.

• 80b8efd84042ff8d9c96ce2f8example est l'identifiant unique de la campagne.

• unique-deliveries est la valeur kpi-name de la métrique de campagne endpoint deliveries (remises de points de terminaison). Cette métrique indique le nombre de points de terminaison uniques auxquels les messages ont été remis, pour toutes les exécutions d'une campagne.

• 2019-07-19T00: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-07-26T23: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 d'une campagne à l'aide de AWS CLI, utilisez la get-campaign-date-range-kpi commande et spécifiez les valeurs appropriées pour les paramètres requis :

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

Où :

• application-id est l'identifiant unique du projet associé à la campagne.

• campaign-id est l'identifiant unique de la campagne.

• 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 extrait le nombre de points de terminaison uniques auxquels les messages ont été remis, par toutes les exécutions d'une campagne, du 19 juillet 2019 au 26 juillet 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

Où :

• 1234567890123456789012345example est l'identifiant unique du projet associé à la campagne.

• 80b8efd84042ff8d9c96ce2f8example est l'identifiant unique de la campagne.

• unique-deliveries est la valeur kpi-name de la métrique de campagne endpoint deliveries (remises de points de terminaison). Cette métrique indique le nombre de points de terminaison uniques auxquels les messages ont été remis, pour toutes les exécutions d'une campagne.

• 2019-07-19T00: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-07-26T23: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 d'une campagne à l'aide de AWS SDK pour Java, utilisez la GetCampaignDateRangeKpiRequest méthode de l'API Campaign Metrics. Spécifiez les valeurs appropriées pour les paramètres requis :

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

Où :

• applicationId est l'identifiant unique du projet associé à la campagne.

• campaignId est l'identifiant unique de la campagne.

• 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 extrait le nombre de points de terminaison uniques auxquels les messages ont été remis, par toutes les exécutions d'une campagne, du 19 juillet 2019 au 26 juillet 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")));

Où :

• 1234567890123456789012345example est l'identifiant unique du projet associé à la campagne.

• 80b8efd84042ff8d9c96ce2f8example est l'identifiant unique de la campagne.

• unique-deliveries est la valeur kpi-name de la métrique de campagne endpoint deliveries (remises de points de terminaison). Cette métrique indique le nombre de points de terminaison uniques auxquels les messages ont été remis, pour toutes les exécutions d'une campagne.

• 2019-07-19T00: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-07-26T23: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 remises au point de terminaison (unique-deliveries), utilisée dans les exemples précédents, renvoie une seule valeur : le nombre de points de terminaison uniques auxquels les messages ont été remis, pour toutes les exécutions d'une campagne. Dans ce cas, la réponse JSON est la suivante :

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

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.