PEPINO ZAPdocs
Referência da APIRelatorios

Relatorio de gestao (cards + series)

Ver como Markdown
GET
/v1/inbox/reports/summary

Devolve as metricas agregadas do atendimento numa janela de tempo: os cards do dashboard (total de conversas, receptivas x ativas, pendentes, abertas, resolvidas, novos contatos, total de atendentes), o tempo de primeira resposta (media, mediana e tamanho da amostra), a produtividade por atendente e a serie de conversas abertas por dia. As metricas saem PRONTAS — voce nao reimplementa heuristica. receptiva x ativa vem da direcao de abertura (quem mandou a 1a mensagem); o tempo de primeira resposta usa as ancoras gravadas na conversa. A janela e em datas no fuso de Brasilia (UTC-3); padrao = ultimos 30 dias.

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Query Parameters

from?string

Inicio da janela, data YYYY-MM-DD no fuso de Brasilia (inclusivo). Omitido = 29 dias antes de to.

Formatdate
to?string

Fim da janela, data YYYY-MM-DD no fuso de Brasilia (inclui o dia inteiro). Omitido = hoje. Janela maxima de 366 dias.

Formatdate
instanceId?string

Filtra por uma instancia (numero). Vazio = todas.

assignedUserId?string

Filtra pela conversa atribuida a um atendente. Vazio = todos.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/inbox/reports/summary"
{
  "range": {
    "from": "2019-08-24",
    "to": "2019-08-24"
  },
  "total": 0,
  "receptivos": 0,
  "ativos": 0,
  "pendentes": 0,
  "abertas": 0,
  "resolvidas": 0,
  "novosContatos": 0,
  "atendentes": {
    "total": 0
  },
  "primeiraResposta": {
    "mediaSegundos": 0,
    "medianaSegundos": 0,
    "amostras": 0
  },
  "porAtendente": [
    {
      "userId": "string",
      "nome": "string",
      "email": "string",
      "total": 0,
      "resolvidas": 0
    }
  ],
  "porDia": [
    {
      "dia": "2019-08-24",
      "abertas": 0
    }
  ]
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}