Obter Estatísticas Financeiras

Retorna estatísticas financeiras detalhadas para um host específico, incluindo histórico de custos por mês e dia, relacionados ao número de conversas.

Endpoint: POST /api/externalAPIs/public/tolkyReasoning/getFinancialStats

PropriedadeTipoDescrição
hostIdstring (UUID)Identificador único do host (obrigatório)
startDatestring (date-time)Data inicial para filtrar as estatísticas financeiras (obrigatório)
endDatestring (date-time)Data final para filtrar as estatísticas financeiras (obrigatório)

Exemplo cURL:

curl -X POST \
  '{BASE_URL}/api/externalAPIs/public/tolkyReasoning/getFinancialStats' \
  -H 'Content-Type: application/json' \
  -d '{
    "hostId": "uuid-do-host",
    "startDate": "2025-01-01",
    "endDate" : "2025-01-31",
  }'

Resposta de Exemplo:

{
  "code": 200,
  "message": "OK",
  "data": [
    {
      "history_months": [
        {
          "mês": "2025-03-01T03:00:00.000Z",
          "total_conversations": "272",
          "total_cost": "530.40"
        },
        {
          "mês": "2025-04-01T03:00:00.000Z",
          "total_conversations": "3483",
          "total_cost": "6791.85"
        },
        {
          "mês": "2025-05-01T03:00:00.000Z",
          "total_conversations": "2898",
          "total_cost": "5651.10"
        }
      ],
      "history_days": [
        {
          "dia": "2025-05-01T03:00:00.000Z",
          "total_conversations": "251",
          "total_cost": "489.45"
        },
        {
          "dia": "2025-05-02T03:00:00.000Z",
          "total_conversations": "435",
          "total_cost": "848.25"
        }
      ]
    }
  ]
}

Códigos de Erro:

  • 400: Campos obrigatórios ausentes ou inválidos
  • 401: Token de autenticação inválido ou ausente
  • 404: Dados não encontrados
  • 500: Erro interno do servidor

Notas:

  • Requer autenticação válida através do tolkyAuthMiddleware
  • O parâmetro hostId é automaticamente extraído das credenciais de autenticação
  • Fornece análises históricas de custos por mês e por dia para o período solicitado
  • Os custos são calculados com base no número de conversas e na precificação contratada