Consultar datos de análisis de Amazon Pinpoint para una campaña

Para consultar los datos de una campaña, utilice la API Métricas de campaña y especifique valores para los siguientes parámetros obligatorios:

• application-id: el ID del proyecto, que es el identificador único del proyecto asociado a la campaña. En Amazon Pinpoint, los términos proyecto y aplicación tienen el mismo significado.

• campaign-id: el identificador único de la campaña.

• kpi-name: el nombre de la métrica que se va a consultar. Este valor describe la métrica asociada y consta de dos o más términos, que se componen de caracteres alfanuméricos en minúsculas, separados por un guion. Para obtener una lista completa de las métricas admitidas y el valor kpi-name de cada una de ellas, consulte Métricas estándar para proyectos, campañas y recorridos.

También puede aplicar un filtro que consulte los datos de un intervalo de fechas determinado. Si no especifica un intervalo de fechas, Amazon Pinpoint devuelve los datos de los 31 días naturales anteriores. Para filtrar los datos por fechas diferentes, utilice los parámetros de intervalo de fechas admitidos para especificar la primera y la última fecha y hora del intervalo de fechas. Los valores deben estar en formato ISO 8601 extendido y utilizar la hora universal coordinada (UTC), por ejemplo, 2019-07-19T20:00:00Z para el 19 de julio de 2019 a las 20:00 UTC. Los intervalos de fechas son inclusivos y deben tener 31 días naturales o menos. Además, la primera fecha y hora deben ser inferiores a 90 días desde el día actual.

En los siguientes ejemplos se muestra cómo consultar los datos de análisis de una campaña mediante la API REST de Amazon Pinpoint AWS CLI, la y la. AWS SDK para Java Puede usar cualquier AWS SDK compatible para consultar los datos de análisis de una campaña. Los AWS CLI ejemplos están formateados para Microsoft Windows. Para Unix, Linux y macOS, reemplace el carácter de continuación de línea de intercalación (^) por una barra invertida (\).

REST API

Para consultar los datos de análisis de una campaña mediante la API de REST de Amazon Pinpoint, envíe una solicitud HTTP(S) GET al URI Métricas de campaña. En el URI, especifique los valores apropiados para los parámetros de ruta requeridos:

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

Donde:

• endpointes el punto de enlace de Amazon Pinpoint para la AWS región que aloja el proyecto asociado a la campaña.

• application-id es el identificador único del proyecto asociado a la campaña.

• campaign-id es el identificador único de la campaña.

• kpi-namees el kpi-name valor de la métrica que se va a consultar.

Todos los parámetros deben tener codificación URL.

Para aplicar un filtro que consulta los datos de un intervalo de fechas específico, agregue los parámetros de consulta start-time y end-time y los valores al URI. Estos parámetros permiten especificar la primera y última fecha y hora, en formato ISO 8601 ampliado, de un intervalo de fechas inclusivo para recuperar los datos. Utilice un signo ampersand (&) para separar los parámetros.

Por ejemplo, la siguiente solicitud recupera el número de puntos de enlace únicos a los que se entregaron los mensajes, en todas las ejecuciones de una campaña, desde el 19 de julio de 2019 hasta el 26 de julio de 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

Donde:

• pinpoint.us-east-1.amazonaws.com es el punto de conexión de Amazon Pinpoint de la región de AWS que aloja el proyecto.

• 1234567890123456789012345example es el identificador único del proyecto asociado a la campaña.

• 80b8efd84042ff8d9c96ce2f8example es el identificador único de la campaña.

• unique-deliveries es el valor kpi-name de la métrica de campaña entregas a puntos de enlace que es la métrica que informa sobre el número de puntos de enlace únicos a los que se entregaron los mensajes en todas las ejecuciones de una campaña.

• 2019-07-19T00:00:00Z es la primera fecha y hora para recuperar datos dentro de un intervalo de fechas inclusivo.

• 2019-07-26T23:59:59Z es la última fecha y hora para recuperar datos dentro de un intervalo de fechas inclusivo.

AWS CLI

Para consultar los datos de análisis de una campaña mediante el AWS CLI, utilice el get-campaign-date-range-kpi comando y especifique los valores adecuados para los parámetros necesarios:

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

Donde:

• application-id es el identificador único del proyecto asociado a la campaña.

• campaign-id es el identificador único de la campaña.

• kpi-namees el kpi-name valor de la métrica que se va a consultar.

Para aplicar un filtro que consulte los datos de un intervalo de fechas específico, agregue los parámetros start-time y end-time a la consulta. Estos parámetros permiten especificar la primera y última fecha y hora, en formato ISO 8601 ampliado, de un intervalo de fechas inclusivo para recuperar los datos. Por ejemplo, la siguiente solicitud recupera el número de puntos de enlace únicos a los que se entregaron los mensajes, en todas las ejecuciones de una campaña, desde el 19 de julio de 2019 hasta el 26 de julio de 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

Donde:

• 1234567890123456789012345example es el identificador único del proyecto asociado a la campaña.

• 80b8efd84042ff8d9c96ce2f8example es el identificador único de la campaña.

• unique-deliveries es el valor kpi-name de la métrica de campaña entregas a puntos de enlace que es la métrica que informa sobre el número de puntos de enlace únicos a los que se entregaron los mensajes en todas las ejecuciones de una campaña.

• 2019-07-19T00:00:00Z es la primera fecha y hora para recuperar datos dentro de un intervalo de fechas inclusivo.

• 2019-07-26T23:59:59Z es la última fecha y hora para recuperar datos dentro de un intervalo de fechas inclusivo.

SDK for Java

Para consultar los datos de análisis de una campaña mediante el AWS SDK para Java, utilice el GetCampaignDateRangeKpiRequest método de la API Campaign Metrics. Especifique los valores apropiados para los parámetros requeridos:

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

Donde:

• applicationId es el identificador único del proyecto asociado a la campaña.

• campaignId es el identificador único de la campaña.

• kpiNamees el kpi-name valor de la métrica que se va a consultar.

Para aplicar un filtro que consulte los datos de un intervalo de fechas específico, incluya los parámetros startTime y endTime y los valores en la consulta. Estos parámetros permiten especificar la primera y última fecha y hora, en formato ISO 8601 ampliado, de un intervalo de fechas inclusivo para recuperar los datos. Por ejemplo, la siguiente solicitud recupera el número de puntos de enlace únicos a los que se entregaron los mensajes, en todas las ejecuciones de una campaña, desde el 19 de julio de 2019 hasta el 26 de julio de 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")));

Donde:

• 1234567890123456789012345example es el identificador único del proyecto asociado a la campaña.

• 80b8efd84042ff8d9c96ce2f8example es el identificador único de la campaña.

• unique-deliveries es el valor kpi-name de la métrica de campaña entregas a puntos de enlace que es la métrica que informa sobre el número de puntos de enlace únicos a los que se entregaron los mensajes en todas las ejecuciones de una campaña.

• 2019-07-19T00:00:00Z es la primera fecha y hora para recuperar datos dentro de un intervalo de fechas inclusivo.

• 2019-07-26T23:59:59Z es la última fecha y hora para recuperar datos dentro de un intervalo de fechas inclusivo.

Después de enviar la consulta, Amazon Pinpoint devuelve los resultados de la consulta en una respuesta JSON. La estructura de los resultados varía en función de la métrica que haya consultado. Algunas métricas solo devuelven un valor. Por ejemplo, la métrica de la campaña entregas a puntos de conexión (unique-deliveries), que se utiliza en los ejemplos anteriores, devuelve un valor: el número de puntos de conexión únicos a los que se entregaron los mensajes en todas las tiradas de una campaña. En este caso, la respuesta JSON es la siguiente:

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

Otras métricas devuelven varios valores y agrupan los valores por un campo relevante. Si una métrica devuelve varios valores, la respuesta JSON incluye un campo que indica qué campo se utilizó para agrupar los datos.

Para obtener más información sobre la estructura de los resultados de la consulta, lea Usar resultados de consultas JSON.