Query consumption dashboard

Query consumption dashboard. See the OpenAPI-defined parameters, request body, and responses below.

OpenAPI description: Consulta o dashboard de consumo conforme os filtros do corpo da requisição. Retorna um resumo de agentes, valores contratados e consumidos, consumo por item e dia e dimensões de consumo. Apesar de usar POST, esta operação é uma consulta e não registra consumo nem altera cotas.

Authentication

Authentication required. Send your user API key in the X-API-Key header.

Parameters

This operation has no path, query, or header parameters.

Request body

Content type: application/json · Schema: ConsumptionDashboardFilterDto

Example request

curl --request POST \
  --url 'https://api.zild.ai/ConsumptionDashboard' \
  --header 'X-API-Key: YOUR_USER_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "departmentId": 0,
  "usageMode": 0,
  "isBillable": true,
  "startDate": "2026-09-22T18:00:00Z",
  "endDate": "2026-09-22T18:00:00Z",
  "groupBy": 0,
  "productType": 0,
  "userId": 0,
  "agentId": 0,
  "agentType": 0,
  "agentAIType": 0,
  "model": "string"
}'

Responses

Example response (200):

{
  "agents": {
    "total": 0,
    "active": 0,
    "inactive": 0
  },
  "contractedVsConsumed": {
    "contractedValue": 0,
    "consumedValue": 0,
    "currency": "string",
    "consumptionPercentage": 0
  },
  "consumptionByItemPerDay": [
    {
      "date": "2026-09-22T18:00:00Z",
      "itemName": "string",
      "quantity": 0,
      "unitMeasure": "string"
    }
  ],
  "subscriptionConsumptions": [
    {
      "productType": 0,
      "productTypeName": "string",
      "productName": "string",
      "productDescription": "string",
      "unitMeasure": 0,
      "periodStart": "2026-09-22T18:00:00Z",
      "periodEnd": "2026-09-22T18:00:00Z",
      "quantity": 0,
      "records": 0,
      "distinctUsers": 0,
      "distinctAgents": 0,
      "agentInputTokens": 0,
      "agentOutputTokens": 0,
      "agentCachedTokens": 0,
      "agentReasoningTokens": 0,
      "averageResponseTimeInMilliseconds": 0
    }
  ]
}

Data models