Métricas

URL base da API

https://crm.vdgestaobranding.com/api/v1

A documentação fica em developers.vdgestaobranding.com, mas todas as chamadas vão para crm.vdgestaobranding.com/api/v1.

GET/metrics

metrics:read

Indicadores do período

Disparos (campanhas) e atendimento separados, os mesmos números do painel. Padrão: últimos 30 dias.

from — ISO 8601.
to — ISO 8601.
phone_number_ref — Filtrar por número.

curl -X GET "https://crm.vdgestaobranding.com/api/v1/metrics" \
  -H "Authorization: Bearer $VDCRM_API_KEY"

Resposta 200

{
  "period": {
    "from": "2026-10-01T00:00:00Z",
    "to": "2026-11-01T00:00:00Z"
  },
  "metrics": {
    "campaigns": {
      "sent": 1200,
      "delivered": 1150
    },
    "attendance": {
      "conversations": 300
    }
  }
}

POST/reports

metrics:read

Idempotency-Key

Gerar relatório

Assíncrono. Ao ficar pronto, envia report.ready; consulte GET /reports/{id} para a URL de download (válida por 1 h).

curl -X POST "https://crm.vdgestaobranding.com/api/v1/reports" \
  -H "Authorization: Bearer $VDCRM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "format": "xlsx",
  "from": "2026-10-01T00:00:00Z",
  "to": "2026-11-01T00:00:00Z"
}'

Resposta 202

{
  "id": "rp1…",
  "status": "queued"
}

GET/reports/{id}

metrics:read

Status / download do relatório

curl -X GET "https://crm.vdgestaobranding.com/api/v1/reports/{id}" \
  -H "Authorization: Bearer $VDCRM_API_KEY"

Resposta 200

{
  "id": "rp1…",
  "status": "ready",
  "format": "xlsx",
  "download_url": "https://…"
}