Contactos: actividad

Obtener estadísticas

Totales de toda la cuenta en una llamada: contactos, contactos por estado, miembros por lista y contactos por etiqueta.

POSThttps://g.sendcorex.com/v1/contactscommand: get_stats
i

Necesita el scope contact:read en tu API key.

i

Son contadores que se actualizan con cada cambio, así que es barato llamarlo cuando se abre un dashboard.

Argumentos

Este endpoint no recibe argumentos.

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "get_stats"
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Respuesta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_stats",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "total": 2040,
        "status": {
          "subscribed": 1951,
          "unsubscribed": 61,
          "bounced": 22,
          "complained": 3,
          "blocked": 3
        },
        "lists": {
          "customers": {
            "total": 1834,
            "ok": 1790,
            "opened": 912,
            "clicked": 233
          },
          "newsletter": {
            "total": 640,
            "ok": 602,
            "opened": 288,
            "clicked": 41
          }
        },
        "tags": {
          "customer": 1834,
          "vip": 120,
          "black-friday": 512
        }
      }
    }
  ]
}

Campos de la respuesta

  • total

    Contactos en la cuenta.

  • status

    Contactos por estado global.

  • lists.<id>

    total de miembros, ok miembros a los que se puede enviar, y miembros que opened o clicked.

  • tags

    Contactos por etiqueta.

Errores

Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.

  • 401INVALID_API_KEY

    La API key no existe, se revocó o se desactivó en el dashboard.

  • 429RATE_LIMITED

    Más de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.

  • CMDMISSING_SCOPE

    La API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.