Read Statistics by Company ID

Retorna las estadísticas de los últimos 7 días de las campaigns, además contiene una búsqueda por rango de fechas.

Descripción de los valores del campo statistics:

• total: Cantidad total de notificaciones programadas hasta el momento en esta campaña.
• pending: Cantidad de notificaciones que aún no han podido ser enviadas por cualquier motivo.
• fails: Cantidad de notificaciones no se pudo enviar y qué no tendran mas reintentos de envío, el caso más común para que esto ocurra es que el usuario desinstala la app de su celular.
• sended: Cantidad de notificaciones enviadas exitosamente, esto no confirma que ese mensaje llegue al receptor.
• actions: El campo actions contiene información de las notificaciones que se pudieron enviar exitosamente.
  • RECEIVED: El mensaje fue recibido exitosamente por el equipo receptor, este estado no confirma si el mensaje fue visto o no.
  • PRESS_ACTION: El mensaje fue visto y el usuario presionó en el botón de acción del mensaje.
  • CLOSED: El mensaje fue visto pero el usuario presiono en el botón cerrar del mensaje.
  • UNKNOWN: El mensaje falló al renderizarse en el equipo o otro error desconocido al recibir el mensaje.

Endpoint

Headers

Key	Value	Description
Content-Type	application/json
Authorization	Bearer {{access_token}}	access_token obtained in Atenea

Url

Method: GET
URL: https://api.trust.lat/campaigns/api/v1/company/:company_id/statistics

caution

Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea

Como obtener un access token

Code Examples

Curl

curl --location --request GET 'https://api.trust.lat/campaigns/api/v1/company/1/statistics' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Bearer {{accessToken}}'

JavaScript

import requests

url = "https://api.trust.lat/campaigns/api/v1/company/1/statistics"

payload={}
headers = {
  'Content-Type': 'text/plain',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Python

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.trust.lat/campaigns/api/v1/company/1/statistics',
  headers: { 
    'Content-Type': 'text/plain', 
    'Authorization': 'Bearer {{accessToken}}'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Responses

HTTP Code: 200 Empty

{
    "code": 200,
    "resource": "Statistics",
    "data": {
        "total": 0,
        "sended": 0,
        "pending": 0,
        "fails": 0,
        "actions": {
            "RECEIVED": 0,
            "PRESS_ACTION": 0,
            "UNKNOWN": 0
        },
        "campaign": 0
    },
    "message": "Ok"
}

HTTP Code: 200 Found

{
    "code": 200,
    "resource": "Statistics",
    "data": {
        "total": 6,
        "sended": 0,
        "pending": 0,
        "fails": 6,
        "actions": {
            "RECEIVED": 0,
            "PRESS_ACTION": 4,
            "UNKNOWN": 0
        },
        "campaign": 5
    },
    "message": "Ok"
}