API de estadísticas

info Esta es la versión más reciente de la API de estadísticas (Stats API). Las mejoras de la versión v4 son las siguientes:

Se utiliza la autenticación básica HTTP (HTTP Basic Authentication) para autorizar el acceso. De este modo, toda la solicitud a la API se puede completar con herramientas HTTP comunes, como curl y complementos del navegador.
El contenido del push está en formato JSON.

Visión general

Stats API v4 proporciona múltiples funciones de consulta de datos.

Validación de llamadas

Para obtener más información, consulte Método de autenticación

Estadísticas de mensajes

Consultar las estadísticas de cada estado en el ciclo de vida (lifecycle) de message_id.
Las estadísticas de cada mensaje push se pueden conservar como máximo durante un mes.

URI de la API de solicitud

GET v4/messages/details

Ejemplo de solicitud

curl -v https://webpushapi-sgp.engagelab.com/v4/messages/details?message_ids=1613113584,1229760629 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/messages/details?message_ids=1613113584,1229760629 HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

              
              curl -v https://webpushapi-sgp.engagelab.com/v4/messages/details?message_ids=1613113584,1229760629 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

< GET /v4/messages/details?message_ids=1613113584,1229760629 HTTP/1.1
< Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

Este bloque de código se muestra en una ventana flotante

Parámetros de solicitud

Palabras clave	Tipo	Opción	Descripción
message_ids	String	Obligatorio	`<li>`ID de mensaje; varios message_ids se separan por ","`<li>`hasta 100 messages_ids

Ejemplo de respuesta

< HTTP/1.1 200 OK < Content-Type: application/json { "1083008": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 1, "clicks": 0, "sub": { "notification": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 1, "clicks": 0, "sub_web": { "engageLab_web": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "chrome": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 1, "clicks": 0 }, "safari": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "firefox": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "edge": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "other": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } } }, "message": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } }, "plan_id": "engageLab_msg", "pushContent": { "message": { "title": "msg", "content": "push" } } } }

              
              < HTTP/1.1 200 OK
< Content-Type: application/json
{
    "1083008": {
        "targets": 1,
        "sent": 1,
        "delivered": 1,
        "impressions": 1,
        "clicks": 0,
        "sub": {
            "notification": {
                "targets": 1,
                "sent": 1,
                "delivered": 1,
                "impressions": 1,
                "clicks": 0,
                "sub_web": {
                    "engageLab_web": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "chrome": {
                        "targets": 1,
                        "sent": 1,
                        "delivered": 1,
                        "impressions": 1,
                        "clicks": 0
                    },
                    "safari": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "firefox": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "edge": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "other": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    }
                }
            },
            "message": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
            }
        },
        "plan_id": "engageLab_msg",
        "pushContent": {
            "message": {
                "title": "msg",
                "content": "push"
            }
        }
    }
}

Este bloque de código se muestra en una ventana flotante

Parámetros de respuesta

Palabras clave	Tipo	Opción	Descripción
targets	Int64	Obligatorio	Objetivos efectivos.
sent	Int64	Obligatorio	Cantidad enviada.
delivered	Int64	Obligatorio	Cantidad entregada.
impressions	Int64	Obligatorio	Cantidad de visualizaciones.
clicks	Int64	Obligatorio	Número de clics.
sub	Object	Obligatorio	Indicadores desglosados de los datos estadísticos.
plan_id	String	Obligatorio	ID del plan de push.
pushContent	Object	Obligatorio	Detalles del contenido del push.

Indicador

Palabras clave	Tipo	Opción	Descripción
sub_web	Object	Opcional	Estadísticas resumidas de datos de varios canales de push en el canal Web
engageLab_web	Object	Opcional	Estadísticas resumidas de datos del canal Engagelab
chrome	Object	Opcional	Estadísticas resumidas de datos del canal Chrome
safari	Object	Opcional	Estadísticas resumidas de datos del canal Safari
firefox	Object	Opcional	Estadísticas resumidas de datos del canal Firefox
edge	Object	Opcional	Estadísticas resumidas de datos del canal Edge
other	Object	Opcional	Estadísticas resumidas de datos de otros canales

Estadísticas de usuarios

Proporciona datos estadísticos relevantes de usuarios de un determinado periodo de tiempo dentro de los últimos 2 meses.
Unidad de tiempo: HOUR, DAY, MONTH

URL de la API de solicitud

GET v4/status/users

Parámetros de solicitud

Palabras clave	Tipo	Opción	Descripción
time_unit	String	Opcional	Unidad de tiempo: `<li>`HOUR`<li>`DAY`<li>`MONTH
start	String	Opcional	Hora de inicio
duration	String	Opcional	Duración

Parámetros

Palabras clave	Tipo	Opción	Descripción
time_unit	String	Obligatorio	La unidad de tiempo incluye tres valores: `<li>`HOUR`<li>`DAY`<li>`MONTH
start	String	Obligatorio	Hora de inicio
duration	String	Obligatorio	Duración
items	JSON Array	Obligatorio	Resultados estadísticos

Palabras clave	Tipo	Opción	Descripción
new	Int64	Opcional	Usuario nuevo
online	Int64	Opcional	Usuario en línea
active	Int64	Opcional	Usuario activo

Consultar el estado del ciclo de vida del mensaje

Parámetros

Palabras clave	Tipo	Opción	Descripción
message_id	String	Obligatorio	ID del mensaje
registration_ids	String	Obligatorio	IDs de registro

Parámetros

Palabras clave	Tipo	Opción	Descripción
status	String	Opcional	Rango de valores: `<li>`plan`<li>`target_valid`<li>`target_invalid`<li>`sent`<li>`sent_failed`<li>`delivered`<li>`delivered_failed`<li>`impression`<li>`click
error_message	String	Opcional	Mensaje de error

Consulta por lotes del estado del ciclo de vida del mensaje

Descripción de los parámetros de respuesta

Palabras clave	Tipo	Opciones	Descripción
message_id	String	Obligatorio	El `message_id` del mensaje
registration_id	String	Opcional	El `registration_id` consultado
status	String	Opcional	Estado del mensaje
itime	Int64	Opcional	Hora de actualización
channel	String	Opcional	Canal de envío
error_message	String	Opcional	Mensaje de error
error_code	Int64	Opcional	Código de error

Resultado de la solicitud

Código de negocio devuelto

Código	Descripción	Código de estado HTTP
0	Éxito	200
21001	URL incorrecta	404
21003	Parámetro no válido	400
23001	Error de autenticación	401
23100	Error del servidor	500