Estadísticas de mensajes

messages:list

Muestra la lista de mensajes enviados.

POST https://api.pushwoosh.com/api/v2/messages:list

Cabeceras

Nombre	Requerido	Descripción
`Authorization`	Sí	Token de la API del servidor. Debe proporcionarse en el siguiente formato: `Authorization: Api <Server Key>`.

Parámetros del cuerpo de la solicitud

Nombre	Requerido	Tipo	Descripción
`platforms`	No	Array	Plataformas de mensajes. Valores posibles: `"IOS"`, `"ANDROID"`, `"OSX"`, `"WINDOWS"`, `"AMAZON"`, `"SAFARI"`, `"CHROME"`, `"FIREFOX"`, `"IE"`, `"EMAIL"`, `"HUAWEI_ANDROID"`, `"SMS"`.
`date_range`	No	Object	Período del informe, filtrado por fecha de creación del mensaje. `date_from` y `date_to` deben seguir el formato `YYYY-MM-DD` (p. ej., `"2000-01-01"`); ambos días se incluyen completos, por lo que si `date_from` y `date_to` se establecen en la misma fecha, se devuelve ese día completo.
`campaign`	No	String	Código de campaña
`filters`	Sí	Object	Filtros de mensajes.
`source`	No	String	Fuente del mensaje. Por ejemplo: `AB_TEST`, `API`, `AUTO_PUSH`, `CP`, `CSV`, `CUSTOMER_JOURNEY`, `EMAIL_API`, `EMAIL_CP`, `GEO_ZONE`, `PUSH_ON_EVENT`, `RSS`.
`messages_codes`	No	Array	Códigos de mensaje obtenidos de las respuestas de la API `/createMessage`.
`messages_ids`	No	Array	ID de mensajes obtenidos del Historial de mensajes
`params`	No	Object	Especifica si se deben mostrar los detalles y las métricas del mensaje. Establece `with_details: true` para incluir el objeto `"details"` y `with_metrics: true` para incluir el objeto `"metrics"` en la respuesta.
`application`	Sí	String	Código de aplicación de Pushwoosh.
`per_page`	No	Integer	Número de resultados por página, de `1` a `499`. Omite el parámetro para obtener el tamaño de página predeterminado de 500 resultados; pasar `500` o más explícitamente es rechazado con un `400`.
`page`	No	Integer	Número de página basado en cero para la paginación. Consulta el límite de paginación profunda a continuación.

Ejemplo de solicitud

{
    "filters": {
      "platforms": [],                  // IOS, ANDROID, OSX, WINDOWS, AMAZON, SAFARI, CHROME, FIREFOX, IE, EMAIL, HUAWEI_ANDROID, SMS
      "date_range": {
        "date_from": "string",          // Required format: 2000-01-01
        "date_to": "string"             // Required format: 2000-01-01
      },
      "source": "API",                  // AB_TEST, API, AUTO_PUSH, CP, CSV, CUSTOMER_JOURNEY, EMAIL_API, EMAIL_CP, GEO_ZONE, PUSH_ON_EVENT, RSS
      "campaign": "string",             // Campaign code
      "messages_ids": [],               // Message IDs
      "messages_codes": [],             // Message codes
      "application": "string"           // Pushwoosh application code
    },
    "params": {
      "with_details": true,             // Add message details to the response ("details" object)
      "with_metrics": true              // Add message metrics to the response ("metrics" object)
    },
    "per_page": 20,                     // <= 499
    "page": 0
}

Códigos de respuesta y ejemplos

{
  "total": 0,
  "items": [{
    "id": 0,
    "code": "string",
    "created_date": "string",
    "send_date": "string",
    "status": "string",
    "platforms": [],
    "source": "string",
    "push_info": {
      "details": {
        "title": "string",
        "filter_name": "string",
        "filter_code": "string",
        "content": {
          "key": "value"
        },
        "platform_parameters": {
          "android_header": "string",
          "android_root_params": {
            "key": "value"
          },
          "ios_title": "string",
          "ios_subtitle": "string",
          "ios_root_params": {
            "key": "value"
          },
          "chrome_header": "string",
          "chrome_root_params": {
            "key": "value"
          },
          "firefox_header": "string",
          "firefox_root_params": {
            "key": "value"
          },
          "conditions": [               // tag conditions (see /developer/api-reference/messages-api/#tag-conditions)
            TAG_CONDITION1,
            TAG_CONDITION2,
            ...,
            TAG_CONDITIONN
          ],
          "conditions_operator": "AND", // logical operator for conditions arrays; possible values: AND, OR
          "data": {
            "key": "value"
          }
        },
        "follow_user_timezone": true
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "inbox_opens": 0,
        "unshowable_sends": 0,
        "errors": 0,
        "platform": 0
      }]
    },
    "email_info": {
      "details": {
        "template": "string",
        "filter_name": "string",
        "filter_code": "string",
        "subject": {
          "key": "value"
        },
        "from_name": "string",
        "from_email": "string",
        "reply_name": "string",
        "reply_email": "string",
        "follow_user_timezone": true,
        "conditions": [              // tag conditions (see Messages-api - tag-conditions)
          TAG_CONDITION1,
          TAG_CONDITION2,
          ...,
          TAG_CONDITIONN
        ],
        "conditions_operator": "AND" // logical operator for conditions arrays; possible values: AND, OR
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "hard_bounces": 0,
        "soft_bounces": 0,
        "rejects": 0,
        "confirmed_sends": 0,
        "unsubs": 0,
        "complaints": 0,
        "errors": 0
      }]
    }
  }]
}

El date_range abarca más de 30 días:

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

page × per_page excede el límite de paginación profunda:

{
  "error": "requested result window is too large, narrow the date range"
}

{
  "error": "account not found"
}

totalsByIntervals

Devuelve métricas y datos de conversión basados en el código del mensaje, agregados por hora.

POST https://api.pushwoosh.com/api/v2/statistics/messages/totalsByIntervals

Autorización

La autorización se gestiona a través del token de acceso a la API en la cabecera de la solicitud.

Parámetros del cuerpo de la solicitud

Nombre del parámetro	Tipo	Descripción	Requerido
`message_code`	string	Código de mensaje obtenido de las respuestas de la API `/createMessage`.	Sí
`platforms`	[int]	Plataformas	No

Ejemplo de solicitud

{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // required. Unique message identifier
  "platforms": [1, 3, 7, 10, 11, 12]          // optional. List of platform codes
}

Campos de respuesta

Nombre	Tipo	Descripción
`metrics`	array	Contiene un array de métricas de mensajes
`timestamp`	string	La hora de la métrica.
`platform`	int	El código de la plataforma (p. ej., iOS, Android).
`sends`	string	El número de mensajes enviados.
`opens`	string	El número de mensajes abiertos.
`deliveries`	string	El número de mensajes entregados.
`inbox_opens`	string	El número de aperturas de la bandeja de entrada.
`unshowable_sends`	string	El número de mensajes enviados que no se pudieron mostrar.
`errors`	string	El número de errores.
`conversion`	object	Contiene datos de conversión
`sends`	string	El número total de mensajes enviados.
`opens`	string	El número total de mensajes abiertos.
`events`	array	Un array de eventos con sus estadísticas
`name`	string	El nombre del evento (p. ej., añadir al carrito).
`hits`	string	El número de visitas.
`conversion`	float	La tasa de conversión relativa a las aperturas.
`revenue`	float	Los ingresos (solo para eventos con atributos `__amount` y `__currency`).

Ejemplo de respuesta

{
  "metrics": [{
    "timestamp": "2024-08-03 15:00:00",  // Timestamp of the metrics in "YYYY-MM-DD HH:MM:SS" format
    "platform": 3,                       // Platform code
    "sends": "55902",                    // Number of messages sent
    "opens": "382",                      // Number of messages opened
    "deliveries": "22931",               // Number of messages delivered
    "inbox_opens": "0",                  // Number of messages opened in the inbox
    "unshowable_sends": "2",             // Number of messages that couldn't be shown
    "errors": "0"                        // Number of errors encountered
  }],
  "conversion": {
    "sends": "55902",                    // Total number of messages sent
    "opens": "772",                      // Total number of messages opened
    "events": [{
      "name": "cart_add",                // Name of the event
      "hits": "96",                      // Number of hits for the event
      "conversion": 0.12,                // Conversion rate relative to opens
      "revenue": 0                       // Revenue generated by the event (only for events with amount/currency attributes)
    }]
  }
}

getMessageLog

Muestra información detallada sobre los mensajes enviados.

POST https://api.pushwoosh.com/api/v2/statistics/getMessageLog

Cabeceras

Nombre	Requerido	Descripción
`Authorization`	Requerido	Token de acceso a la API del Panel de Control de Pushwoosh.

Parámetros del cuerpo de la solicitud

Nombre	Requerido	Tipo	Descripción
`message_id`	No	Integer	Selecciona eventos de mensajes por ID de mensaje obtenido del historial de mensajes. Ejemplo: `12345678900`.
`message_code`	No	String	Selecciona eventos de mensajes por Código de mensaje obtenido de las respuestas de la API `/createMessage`. Ejemplo: `"A444-AAABBBCC-00112233"`.
`campaign_code`	No	String	Selecciona eventos de mensajes por Código de campaña especificado en la carga útil de tu mensaje. Ejemplo: `"AAAAA-XXXXX"`.
`hwid`	No	String or Array	Selecciona eventos de mensajes por HWID (Hardware ID) o un array de HWIDs.
`date_from`	Requerido si no se proporciona `message_id`, `message_code` o `campaign_code`	Datetime	Fecha de inicio para filtrar mensajes. Formato: `"YYYY-MM-DD HH:MM:SS"`. Ejemplo: `"2000-01-25 00:00:00"`.
`date_to`	Requerido si no se proporciona `message_id`, `message_code` o `campaign_code`	Datetime	Fecha de fin para filtrar mensajes. Formato: `"YYYY-MM-DD HH:MM:SS"`. Ejemplo: `"2000-01-26 00:00:00"`.
`limit`	No	Integer	Número máximo de eventos de mensaje devueltos en una sola respuesta. Valor máximo: `100000`.
`pagination_token`	No	String	Token de paginación obtenido de una respuesta `/getMessageLog` anterior. Úsalo para recuperar resultados adicionales.
`user_id`	No	String	Selecciona eventos de mensajes por un ID de usuario personalizado. Consulta `/registerUser` para más detalles.
`application_code`	Sí	String	Selecciona eventos de mensajes por código de aplicación de Pushwoosh
`actions`	No	Array	Filtra los resultados por acciones de mensaje específicas. Valores posibles: `"sent"`, `"delivered"`, `"opened"`, `"inbox_delivered"`, `"inbox_read"`, `"inbox_opened"`, `"inbox_deleted"`.
`platforms`	No	Array	Array de plataformas de destino para filtrar los resultados. Valores posibles: `"ios"`, `"android"`, `"osx"`, `"windows"`, `"amazon"`, `"safari"`, `"chrome"`, `"firefox"`, `"ie"`, `"email"`, `"huawei_android"`.

Ejemplo de solicitud

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/getMessageLog' \
--header 'Authorization: Key API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "pagination_token": "PAGINATION_TOKEN_FROM_PREVIOUS_RESPONSE",  // optional, token for pagination
   "limit": 1000,                                  // optional, the max number of entries for a single response
   "application_code": "XXXXX-XXXXX",              // Pushwoosh app code
   "message_code": "A444-AAABBBCC-00112233",       // optional, message code obtained from /createMessaage request
   "message_id": 1234567890,                       // optional, message ID obtained from Pushwoosh Control Panel
   "campaign_code": "AAAAA-XXXXX",                 // optional, code of a campaign to get the log for
   "hwid": "aaazzzqqqqxxx",                        // optional, hardware ID of a specific device targeted with a message
   "user_id": "user_123",                          // optional, ID of a user targeted with the message
   "date_from": "2000-01-25 00:00:00",             // optional, start of the stats period
   "date_to": "2000-02-10 23:59:59",               // optional, end of the stats period
   "actions": ["opened", "inbox_opened"],          // optional, used for results filtration. Possible values: "sent", "opened", "delivered", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted". The response will include all the messages with the specified action(s).
   "platforms": ["ios", "chrome"]                  // optional, used for results filtration. Possible values: "ios", "android", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "huawei android"
}'

Códigos de respuesta y ejemplos

{
  "pagination_token": "PAGINATION_TOKEN_FOR_NEXT_REQUEST",
  "data": [{
    "timestamp": "2000-01-25T11:18:47Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "sent",
    "status": "success",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:18:49Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "delivered",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:19:23Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "opened",
    "push_alerts_enabled": "true"
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

Estadísticas de correo electrónico

linksInteractions

Muestra estadísticas sobre los clics en enlaces en los correos electrónicos

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions

Cabeceras

Nombre	Requerido	Descripción
`Authorization`	Sí	Token de acceso a la API del Panel de Control de Pushwoosh.

Parámetros del cuerpo de la solicitud

Nombre	Requerido	Tipo	Descripción
`date_range`	No	Object	Define el período del informe. Contiene `date_from` y `date_to`.
`filters`	Sí	Object	Filtros de correo electrónico.
`application`	Sí	String	Código de aplicación de Pushwoosh (alternativamente, especifica `campaign`, `messages_ids` o `message_codes`).
`messages_codes`	Sí	Array	Códigos de mensaje (alternativamente, especifica `application`, `campaign` o `messages_ids`).
`campaign`	Sí	String	Código de campaña (alternativamente, especifica `application`, `messages_ids` o `message_codes`).
`messages_ids`	Sí	Array	ID de mensajes (alternativamente, especifica `application`, `campaign` o `message_codes`).
`link_template`	Requerido si se especifica `application` o `campaign`.	String	Filtra las interacciones de enlaces de correo electrónico por palabra clave. Solo los enlaces que incluyan el texto especificado en su URL se devolverán en la respuesta de la API. Por ejemplo, si tu correo electrónico contiene enlaces como `https://example.com/news` y `https://example.com/shop`, establecer “link_template”: “shop” devolverá interacciones solo para `https://example.com/shop`.
`email_content_code`	No	String	Identificador único para el contenido del correo electrónico.
`params`	No	Object	Define opciones de respuesta adicionales. Incluye `with_full_links`, que agrega una lista de enlaces completos con estadísticas.

Ejemplo de solicitud

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",           // Required format: 2000-01-01
         "date_to": "string"              // Required format: 2000-01-01
      },
      "campaign": "string",               // Campaign code (you can specify application, messages_ids, or message_codes instead)
      "application": "string",            // Application code (you can specify campaign, messages_ids, or message_codes instead)
      "messages_ids": [],                 // Message IDs (you can specify application, campaign, or message_codes instead)
      "messages_codes": [],               // Message codes (you can specify application, campaign, or message_ids instead)
      "link_template": "string",          // Link template (required if application or campaign is specified)
      "email_content_code": "string"      // Unique identifier for the email content.
   },
   "params": {
      "with_full_links": true             // Specify whether to show detailed statistics. A list of full links with statistics will be passed in the full_links array.
   }
}'

Códigos de respuesta y ejemplos

{
  "items": [{
    "template": "string",
    "link": "string",
    "title": "string",
    "clicks": 0,
    "full_links": [{
      "full_link": "string",
      "clicks": 0
    }]
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

linksInteractionsDevices

Muestra los usuarios que hicieron clic en los enlaces de los correos electrónicos

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices

Cabeceras

Nombre	Requerido	Descripción
`Authorization`	Sí	Token de acceso a la API del Panel de Control de Pushwoosh.

Parámetros del cuerpo de la solicitud

Nombre	Requerido	Tipo	Descripción
`date_range`	No	Object	Define el período del informe. Contiene `date_from` y `date_to`.
`filters`	Sí	Object	Filtros de correo electrónico.
`application`	Sí	String	Código de aplicación de Pushwoosh (alternativamente, especifica `campaign`, `messages_ids` o `message_codes`).
`messages_codes`	Sí	Array	Códigos de mensaje (alternativamente, especifica `application`, `campaign` o `messages_ids`).
`campaign`	Sí	String	Código de campaña (alternativamente, especifica `application`, `messages_ids` o `message_codes`).
`messages_ids`	Sí	Array	ID de mensajes (alternativamente, especifica `application`, `campaign` o `message_codes`).
`link_template`	Requerido si se especifica `application` o `campaign`.	String	Filtra las interacciones de enlaces de correo electrónico por palabra clave. Solo los enlaces que incluyan el texto especificado en su URL se devolverán en la respuesta de la API. Por ejemplo, si tu correo electrónico contiene enlaces como `https://example.com/news` y `https://example.com/shop`, establecer “link_template”: “shop” devolverá interacciones solo para `https://example.com/shop`.
`email_content_code`	No	String	Identificador único para el contenido del correo electrónico.
`page`	No	Integer	Número de página para la paginación.
`per_page`	No	Integer	Número de resultados por página (≤ 1000).

Ejemplo de solicitud

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",         // Required format: 2000-01-01
         "date_to": "string"            // Required format: 2000-01-01
      },
      "campaign": "string",             // Campaign code (you can specify application, messages_ids, or message_codes instead)
      "application": "string",          // Application code (you can specify campaign, messages_ids, or message_codes instead)
      "messages_ids": [],               // Message IDs (you can specify application, campaign, or message_codes instead)
      "messages_codes": [],             // Message codes (you can specify application, campaign, or message_ids instead)
      "link_template": "string",        // Link template (required if application or campaign is specified)
      "email_content_code": "string"    // Unique identifier for the email content.
   },
   "per_page": 100,
   "page": 0
}'

Códigos de respuesta y ejemplos

{
  "total": 0,
  "items": [{
    "timestamp": "string",
    "link": "string",
    "hwid": "string"
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

bouncedEmails

POST https://api.pushwoosh.com/api/v2/statistics/emails/bouncedEmails

Proporciona datos sobre quejas de correo electrónico, rebotes suaves y rebotes duros, incluyendo la fecha, la dirección de correo electrónico y el motivo de cada rebote.

Autorización

La autorización se gestiona a través del token de acceso a la API en la cabecera de la solicitud.

Parámetros del cuerpo de la solicitud

Nombre del parámetro	Tipo	Descripción	Requerido
`application`	string	Código de aplicación de Pushwoosh	Sí
`message_code`	string	Código de mensaje.	Requerido si no se proporciona `date range` o `campaign`
`campaign`	string	Código de campaña.	Requerido si no se proporciona `message_code` o `date range`
`date_from`	string	La fecha de inicio para los datos en el formato `YYYY-MM-DDTHH:MM:SS.000Z` (estándar ISO 8601).	Requerido si no se proporciona `message_code` o `campaign`
`date_to`	string	La fecha de fin para los datos en el formato `YYYY-MM-DDTHH:MM:SS.000Z` (estándar ISO 8601).	Requerido si no se proporciona `message_code` o `campaign`
`per_page`	int	El número de filas por página, máximo 5000.	Sí
`page`	int	El número de página, comenzando desde cero.	Sí
`type`	string	El tipo de rebote: Complaint, Softbounce, Hardbounce.	No

Ejemplo de solicitud

{
  "application": "XXXXX-XXXXX",               // required. Pushwoosh app code
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // required if campaign or date range is not provided.
                                              //          Unique message identifier
  "campaign": "XXXXX-XXXXX",                  // required if message_code or date range is not provided.
                                              //          Campaign code
  "date_from": "2024-07-20T00:00:00.000Z",    // required if message_code or campaign is not provided.
                                              //          Start date in ISO 8601 format "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "date_to": "2024-07-20T00:00:00.000Z",      // required if message_code or campaign is not provided.
                                              //          End date in ISO 8601 format "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "per_page": 1000,                           // required. Number of results per page, maximum 5000
  "page": 5,                                  // optional. Page number, starting from zero
  "type": "Softbounce"                        // optional. The type of bounce: Complaint, Softbounce, Hardbounce
}

Campos de respuesta

Nombre del campo	Tipo	Descripción
`total`	int	El recuento total de filas.
`bounced_emails`	array	Un array de detalles de correos electrónicos rebotados.
├── `email`	string	La dirección de correo electrónico que rebotó.
├── `date`	string	La fecha del rebote (formato: `YYYY-MM-DDTHH:MM:SS.000Z`).
├── `reason`	string	El motivo del rebote.
└── `type`	string	El tipo de rebote: Complaint, Softbounce, Hardbounce.

Ejemplo de respuesta

{
  "total": 25,                             // Total count of rows.
  "bounced_emails": [{
    "email": "example@example.com",        // Email address that bounced
    "date": "2024-07-20T00:00:00.000Z",    // Bounce date in ISO 8601 format
    "reason": "Invalid recipient address", // Reason for the bounce
    "type": "Hardbounce"                   // Type of bounce: Complaint, Softbounce, Hardbounce
  }]
}