Skip to Content
1MSG
ReferenceCampaigns API

Resumo da análise

GET
/api/v1/campaigns/{campaignId}/analytics

Contagens do snapshot feito no envio. dailyLimit é o limite do canal, não uma configuração da campanha. As taxas são frações de 0 a 1.

Authorization

bearer
headerAuthorizationBearer <API key>

Chave gerada em Settings → Developer → API key. Os métodos do Inbox precisam do escopo Inbox. Os métodos de Campaigns precisam do escopo Campaigns.

Path Parameters

campaignId*string

id da campanha retornado na criação ou na lista.

Response Body

application/json
  1. response
campaignId*string

id da campanha.

status*string

Status da campanha.

Value in"draft""sending""pause""completed""failed""scheduled"
recipients*number

Destinatários no snapshot de envio.

sent*number

Destinatários com status sent, delivered ou read.

delivered*number

Destinatários com status delivered ou read.

read*number

Destinatários com status read.

failed*number

Destinatários com status failed.

skipped*number

Destinatários com status skipped.

cancelled*number

Destinatários tirados da fila antes do envio.

queued*number

Destinatários com status queued ou leasing.

replied*number

Destinatários que responderam pelo menos uma vez.

textReplies*number

Destinatários que responderam pelo menos uma vez em texto.

clicks*number

Respostas por botão no snapshot.

uniqueClicks*number

Destinatários que tocaram em pelo menos um botão.

rates*

Frações de destinatários, de 0 a 1, arredondadas para 4 casas decimais. Cada taxa é 0 quando não há destinatários.

buttons*array<>

Toques em botões agrupados pelo id do botão.

queuedRemaining*number

Destinatários que ainda aguardam o envio.

sentThisPortion*number

Envios de template já iniciados na janela atual do limite.

dailyLimit*|

Quantos envios de template este canal pode iniciar em 24 horas corridas, ou null quando o limite é desconhecido ou ilimitado.

nextPortionAt*|

Quando a próxima leva de templates pode começar, ou null quando nenhuma leva está esperando.

Formatdate-time
Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns/string/analytics'
Example Response200
{  "campaignId": "cm3campaign01",  "status": "draft",  "recipients": 12,  "sent": 10,  "delivered": 8,  "read": 4,  "failed": 1,  "skipped": 1,  "cancelled": 0,  "queued": 0,  "replied": 2,  "textReplies": 1,  "clicks": 3,  "uniqueClicks": 2,  "rates": {    "sent": 0.5,    "delivery": 0.4,    "read": 0.25,    "reply": 0.1,    "click": 0.05,    "failed": 0  },  "buttons": [    {      "id": "shop",      "title": "Shop",      "clicks": 4,      "uniqueClicks": 3    }  ],  "queuedRemaining": 0,  "sentThisPortion": 0,  "dailyLimit": 1000,  "nextPortionAt": null}