Contatos: atividade
Obter estatísticas
Totais da conta inteira em uma chamada: contatos, contatos por status, membros por lista e contatos por tag.
https://g.sendcorex.com/v1/contactscommand: get_statsPrecisa do scope contact:read na sua API key.
São contadores atualizados a cada alteração, então é barato chamar quando um dashboard abre.
Argumentos
Este endpoint não recebe argumentos.
Início 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);Resposta
{
"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 da resposta
totalContatos na conta.
statusContatos por status global.
lists.<id>totalde membros,okmembros que podem receber envios, e membros queopenedouclicked.tagsContatos por tag.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 429
RATE_LIMITEDMais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.
- CMD
MISSING_SCOPEA API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.