Ver .md

inbox.dashboard

Painel do atendimento. Números do atendimento só das conversas que o membro enxerga: mine (atribuídas a mim, abertas), queue (abertas sem atendente), resolvedInPeriod (resolvidas entre from e to), byStatus (todas, por status) e avgFirstResponseSeconds (média, nos atendimentos iniciados no período, entre a primeira mensagem do contato e a primeira resposta de uma pessoa; null sem dados). Com viewAsAttendantId (só admin) mine, resolvedInPeriod (resolvidos por ele) e avgFirstResponseSeconds (atendimentos atribuídos a ele no período) são os do atendente indicado; queue e byStatus continuam os das conversas que o admin enxerga. Gráficos e atividade: inbox.dashboard_metrics.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/inbox.dashboard (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: messages:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: inbox_dashboard
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId inbox.dashboard)

Entrada

CampoTipoObrigatórioNota
fromstring (date-time)sim
tostring (date-time)sim
viewAsAttendantIdstring (uuid)não
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "to": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "viewAsAttendantId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "from",
    "to"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/inbox.dashboard \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-10-01T00:00:00-03:00","to":"2026-10-31T23:59:59-03:00"}'

CLI:

node cli/atomiks.mjs inbox.dashboard --json '{"from":"2026-10-01T00:00:00-03:00","to":"2026-10-31T23:59:59-03:00"}'

MCP: ferramenta inbox_dashboard com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "mine": {
      "type": "number"
    },
    "queue": {
      "type": "number"
    },
    "resolvedInPeriod": {
      "type": "number"
    },
    "avgFirstResponseSeconds": {
      "type": [
        "number",
        "null"
      ]
    },
    "byStatus": {
      "type": "object",
      "properties": {
        "open": {
          "type": "number"
        },
        "assigned": {
          "type": "number"
        },
        "resolved": {
          "type": "number"
        },
        "closed": {
          "type": "number"
        }
      },
      "required": [
        "open",
        "assigned",
        "resolved",
        "closed"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "mine",
    "queue",
    "resolvedInPeriod",
    "avgFirstResponseSeconds",
    "byStatus"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).