Consultar datos de análisis de Amazon Pinpoint para varias campañas - Amazon Pinpoint

Aviso de fin de soporte: el 30 de octubre de 2026, AWS finalizará el soporte para Amazon Pinpoint. Después del 30 de octubre de 2026, ya no podrá acceder a la consola de Amazon Pinpoint ni a los recursos de Amazon Pinpoint (puntos de conexión, segmentos, campañas, recorridos y análisis). Para obtener más información, consulte Fin de soporte de Amazon Pinpoint. Nota: en lo APIs que respecta a los SMS, este cambio no afecta a los mensajes de voz, a las notificaciones push móviles, a las OTP y a la validación de números de teléfono, y son compatibles con la mensajería para el usuario AWS final.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Consultar datos de análisis de Amazon Pinpoint para varias campañas

Existen dos formas de consultar los datos de varias campañas. La mejor forma depende de si desea consultar los datos de las campañas asociadas al mismo proyecto. Si es así, también depende de si desea consultar los datos de todas las campañas o solo o subconjunto de ellas.

Para consultar los datos de las campañas asociadas a diferentes proyectos o solo de un subconjunto de campañas asociadas al mismo proyecto, lo mejor es crear y ejecutar una serie de consultas individuales, una para cada campaña para la que desee consultar los datos. En la sección anterior se explica cómo consultar los datos de una sola campaña.

Para consultar los datos de todas las campañas asociadas al mismo proyecto, puede utilizar la API Métricas de aplicación. Especifique valores para los siguientes parámetros obligatorios:

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

  • 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 filtrar los datos por intervalo de fechas. 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 de REST de Amazon Pinpoint, la AWS CLI y AWS SDK para Java. Puede utilizar cualquier SDK de AWS compatible para consultar datos de análisis de una campaña. Los ejemplos de AWS CLI tienen el formato de 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 varias campañas mediante la API de REST de Amazon Pinpoint, envíe una solicitud HTTP(S) GET al URI Métricas de aplicación. En el URI, especifique los valores apropiados para los parámetros de ruta requeridos:

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

Donde:

  • punto de conexión es el punto de conexión de Amazon Pinpoint para la región de AWS que aloja el proyecto asociado a las campañas.

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

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

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

Para aplicar un filtro que recupere 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 campañas de un proyecto, desde el 19 de julio de 2019 hasta el 26 de julio de 2019:

https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/unique-deliveries-grouped-by-campaign?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 las campañas.

  • unique-deliveries-grouped-by-campaign es el valor kpi-name de la métrica de aplicación entregas a puntos de enlace, agrupadas por campaña que es la métrica que devuelve el número de puntos de enlace únicos a los que se entregaron los mensajes por 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 varias campañas con la AWS CLI, utilice el comando get-application-date-range-kpi y especifique los valores adecuados para los parámetros obligatorios:

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

Donde:

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

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

Para aplicar un filtro que recupere los datos de un intervalo de fechas específico, incluya los parámetros start-time y end-time 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 campañas de un proyecto, desde el 19 de julio de 2019 hasta el 26 de julio de 2019:

C:\> aws pinpoint get-application-date-range-kpi ^ --application-id 1234567890123456789012345example ^ --kpi-name unique-deliveries-grouped-by-campaign ^ --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.

  • unique-deliveries-grouped-by-campaign es el valor kpi-name de la métrica de aplicación entregas a puntos de enlace, agrupadas por campaña que es la métrica que devuelve el número de puntos de enlace únicos a los que se entregaron los mensajes por 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 varias campañas mediante AWS SDK para Java, use el método GetApplicationDateRangeKpiRequest de la API Métricas de aplicación. Especifique los valores apropiados para los parámetros requeridos:

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

Donde:

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

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

Para aplicar un filtro que recupere 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 campañas de un proyecto, desde el 19 de julio de 2019 hasta el 26 de julio de 2019:

GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest() .withApplicationId("1234567890123456789012345example") .withKpiName("unique-deliveries-grouped-by-campaign") .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 las campañas.

  • unique-deliveries-grouped-by-campaign es el valor kpi-name de la métrica de aplicación entregas a puntos de enlace, agrupadas por campaña que es la métrica que devuelve el número de puntos de enlace únicos a los que se entregaron los mensajes por 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. Otras métricas devuelven varios valores y esos valores se agrupan por 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.

Por ejemplo, la métrica de la aplicación entregas de puntos de conexión, agrupadas por campaña (unique-deliveries-grouped-by-campaign), que se utiliza en los ejemplos anteriores, devuelve valores múltiples: el número de puntos de conexión únicos a los que se entregaron los mensajes, para cada campaña asociada a un proyecto. En este caso, la respuesta JSON es la siguiente:

{ "ApplicationDateRangeKpiResponse":{ "ApplicationId":"1234567890123456789012345example", "EndTime":"2019-07-26T23:59:59Z", "KpiName":"unique-deliveries-grouped-by-campaign", "KpiResult":{ "Rows":[ { "GroupedBys":[ { "Key":"CampaignId", "Type":"String", "Value":"80b8efd84042ff8d9c96ce2f8example" } ], "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"123.0" } ] }, { "GroupedBys":[ { "Key":"CampaignId", "Type":"String", "Value":"810c7aab86d42fb2b56c8c966example" } ], "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"456.0" } ] }, { "GroupedBys":[ { "Key":"CampaignId", "Type":"String", "Value":"42d8c7eb0990a57ba1d5476a3example" } ], "Values":[ { "Key":"UniqueDeliveries", "Type":"Double", "Value":"789.0" } ] } ] }, "StartTime":"2019-07-19T00:00:00Z" } }

En este caso, el campo GroupedBys indica que los valores están agrupados por ID de campaña (CampaignId).

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