WhatsApp Analytics

Las analíticas de WhatsApp le permiten recuperar métricas detalladas de los números de teléfono de empresa y las plantillas asociadas a su WABA. Algunos ejemplos son el número y el tipo de mensajes enviados, el número de veces que se ha leído una plantilla determinada y el número de veces que se ha hecho clic en un botón de una plantilla.

Análisis de mensajería

Los análisis de mensajería proporcionan el número y tipo de mensajes enviados y entregados por los números de teléfono asociados a un WABA específico.

Ejemplo de solicitud

Para recuperar los análisis de mensajería, envíe una solicitud

GET
al siguiente punto final, sustituyendo waba_id con el ID de la WhatsApp Business Account de la que desea recuperar datos de análisis de mensajería:

https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/messaging-analytics

Los datos se devuelven con una granularidad de media hora, diaria o mensual en la zona horaria UTC, con una retrospectiva de hasta 90 días. Debe incluir los parámetros de inicio, fin y granularidad en su solicitud, y hay algunos parámetros opcionales que puede utilizar para filtrar aún más los datos:

Nombre Tipo Requerido Notas
start cadena(timestamp) Sí El formato de fecha y hora de inicio de los datos analíticos que se van a recuperar, en el formato YYYY-MM-DD.
end cadena(timestamp) Sí El formato de la fecha y hora finales a las que se recuperarán los datos analíticos, en el formato YYYY-MM-DD.
granularity cadena Sí Granularidad de los datos analíticos que deben recuperarse. Se admiten: MEDIA HORA, DIARIO, MENSUAL
phone_number matriz No Numbers téléphoniques pour lesquels vous souhaitez obtenir des analyse. Si está vacío, se incluyen todos los números de teléfono asociados a WABA.
product_types matriz No Una matriz de los tipos de mensajes para los que se recuperarán los análisis. Los valores posibles son 0 para mensajes de notificación y/o 2 para los mensajes de atención al cliente. Si no se especifica, se devolverán análisis para todos los tipos de mensajes.
country_codes matriz No Códigos de país de dos letras para los países de los que desea obtener datos analíticos. Si no se especifica, se mostrarán los análisis de todos los países.

Encontrará un ejemplo de código completo en Recuperar análisis de mensajería fragmento de código.

Ejemplo de respuesta

{
   "id": "345688589250625",
   "granularity": "HALF_HOUR",
   "phone_numbers": [
      "16505550111"
   ],
   "country_codes": [
      "US"
   ],
   "_embedded": {
      "messaging_analytics": [
         {
            "start": "1543543200",
            "end": "1543629600",
            "sent": 100,
            "delivered": 90
         }
      ]
   },
   "paging": {
      "cursors": {
         "before": "MAZDZD",
         "after": "MjQZD"
      },
      "next": "https://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?after=MAZDZD",
      "previous": "https://api.nexmo.com/v2/channel-manager/wabas/106499765517625/messaging-analytics?before=MjQZD"
   }
}

Plantilla de análisis

Los análisis de plantillas describen el número de veces que se ha enviado, entregado y leído una plantilla, así como el número de veces que se ha hecho clic en los botones URL o de respuesta rápida de la plantilla; los análisis de clics en botones sólo están disponibles para las plantillas clasificadas como MARKETING o UTILITY.

Los datos se devuelven con una granularidad diaria en la zona horaria UTC con una retrospectiva de hasta 90 días.

Nota: Debe confirmar el análisis de plantillas en su cuenta de empresa antes de poder recuperar el análisis de plantillas. Consulte la Documentación de WhatsApp para más información.

Ejemplo de solicitud

Para recuperar los análisis de plantillas, envíe una solicitud

GET
al siguiente punto final, sustituyendo waba_id con el ID de la WhatsApp Business Account de la que desea recuperar datos de análisis de plantillas:

https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/template-analytics

Los parámetros de consulta que se detallan a continuación pueden utilizarse para filtrar los resultados:

Nombre Tipo Requerido Notas
start cadena(timestamp) Sí El formato de fecha y hora de inicio de los datos analíticos que se van a recuperar, en el formato YYYY-MM-DD.
end cadena(timestamp) Sí La fecha y hora finales a las que se recuperarán los datos analíticos, en el formato YYYY-MM-DD. La diferencia máxima entre las fechas de inicio y fin es de 90 días.
granularity cadena Sí Debe ser DIARIO.
template_ids matriz Sí Una matriz de template_ids de la(s) plantilla(s) para la(s) que se desea recuperar el análisis. Máximo 10.
metric_types matriz No Una matriz de los tipos de métricas para los que recuperar los análisis. Los valores posibles son SENT, DELIVERED, READy CLICKED. Puede obtener más información sobre el significado de cada tipo en la documentación de WhatsApp. Si está vacío, se devolverán los análisis de todos los tipos de métricas.

Ejemplo de respuesta

{
   "granularity": "DAILY",
   "product_type": "cloud_api",
   "page_size": 100,
   "_embedded": {
      "template_analytics": [
         {
            "template_id": "458951126288942",
            "start": "2024-11-11T00:00:00Z",
            "end": "2024-11-11T00:00:00Z",
            "sent": 100,
            "delivered": 90,
            "read": 80,
            "clicked": 70
         }
      ]
   },
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/template-analytics?template_ids=[458951126288937]&start=2024-11-10&end=2024-11-14&page_size=100&cursor=c2VsZj1udWxs"
      }
   }
}

Análisis de precios

Los análisis de precios le permiten recuperar desgloses de precios e información de niveles para cualquier mensaje entregado dentro de un intervalo de fechas especificado.

Ejemplo de solicitud

Para recuperar los análisis de precios, envíe una solicitud

GET
al siguiente punto final, sustituyendo waba_id con el ID de la WhatsApp Business Account de la que desea recuperar datos de análisis de plantillas:

https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/:waba_id/pricing-analytics

Los parámetros de consulta que se detallan a continuación pueden utilizarse para filtrar los resultados:

Nombre Tipo Requerido Notas
start cadena(timestamp) No La fecha y hora de inicio de los datos analíticos que se van a recuperar, en el formato YYYY-MM-DD.
end cadena(timestamp) No La fecha y hora finales a las que se recuperarán los datos analíticos, en el formato YYYY-MM-DD.
granularity cadena No Debe ser uno de HALF_HOUR, DAILYo MONTHLY.
phone_numbers matriz No Numbers de teléfono de los que desea obtener datos analíticos. Si no se especifica, se devolverán los análisis de todos los números de teléfono asociados al WABA. Ejemplo: [ "16505550111" ]
country_codes matriz No Códigos de país de dos letras para los países de los que desea obtener datos analíticos. Si no se especifica, se mostrarán los análisis de todos los países. Ejemplo: [ "US" ]
dimensions matriz No Lista de desgloses que desea aplicar a sus métricas. Si está vacía, se devolverán todos los resultados sin desgloses. Puede incluir PRICING_CATEGORY, PRICING_TYPE, COUNTRY, PHONEy TIER.
tier matriz No El valor de la propiedad tier representa una concatenación de los límites inferior y superior para el tier específico del par mercado-categoría (país y pricing_category). Ejemplo: [ "0:100000" ]

Ejemplo de respuesta

{
   "granularity": "DAILY",
   "product_type": "cloud_api",
   "_embedded": {
      "pricing_analytics": [
         {
            "start": "2024-11-11T00:00:00Z",
            "end": "2024-11-11T00:00:00Z",
            "volume": 100,
            "phone_number": "14155552671",
            "country": "US",
            "tier": "75000:150000",
            "pricing_type": "REGULAR",
            "pricing_category": "AUTHENTICATION"
         }
      ]
   },
   "paging": {
      "cursors": {
         "before": "MjQZD",
         "after": "MAZDZD"
      },
      "previous": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MjQZD",
      "next": "https://api.nexmo.com/v1/channel-manager/whatsapp/wabas/345688589250625/pricing-analytics?before=MAZDZD"
   }
}

Lecturas complementarias