Read Campaign using Campaign UUID

Este endpoint retorna información de la campaña acompañado de el campo statistics que contiene el estado de las notificaciones, statistics no siempre representa el estado actual de la campaña, los valores contenido se actualizan en momentos determinados de la campaña.

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 presionó 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

Endpoint:

Method: GET
Type: 
URL: https://api.trust.lat/campaigns/api/v1/campaign/:campaign_uid

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/campaign/ef24e6b-496c-4724-be1f-3a719586f0a' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Bearer `{{access_token}}`'

JavaScript

import requests

url = "https://api.trust.lat/campaigns/api/v1/campaign/ef24e6b-496c-4724-be1f-3a719586f0a"

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

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

print(response.text.encode('utf8'))

Python

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api.trust.lat/campaigns/api/v1/campaign/ef24e6b-496c-4724-be1f-3a719586f0a',
  headers: { 
    'Content-Type': 'text/plain', 
    'Authorization': 'Bearer `{{access_token}}`'
  }
};

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

Responses

HTTP Code: 200 OK

{
    "code": 200,
    "resource": "Campaign",
    "data": {
        "application_name": "com.bundle_id.company",
        "company_id": "1",
        "created_at": "2020-05-19T21:26:07.228Z",
        "message_id": "4b4865d2-3d90-4ca2-bd8c-93n3910",
        "name": "CAMPAIGN-13909023",
        "statistics": {
            "total": 0,
            "sended": 0,
            "pending": 0,
            "fails": 0,
            "actions": {
                "RECEIVED": 0,
                "PRESS_ACTION": 0,
                "CLOSED": 0,
                "UNKNOWN": 0
            }
        },
        "terminated": false,
        "updated_at": "2020-05-19T21:26:07.228Z",
        "uuid": "5f92aa54b-e964-49fd-89b7-94739ndjaw2"
    },
    "message": "Found"
}

HTTP Code: 404 Not Found

{
    "code": 404,
    "resource": "Campaign",
    "message": "Not found"
}