Consultar dashboard de consumo

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.

POST /ConsumptionDashboard

Autenticação

Autenticação obrigatória. Envie sua chave de API de usuário no header X-API-Key.

Parâmetros

Esta operação não possui parâmetros de rota, query ou header.

Corpo da requisição

Content type: application/json · Schema: ConsumptionDashboardFilterDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`departmentId`	`integer · int32`	Não	—	aceita null
`usageMode`	`TenantUsageMode`	Não	—	—
`isBillable`	`boolean`	Não	—	aceita null
`startDate`	`string · date-time`	Não	—	aceita null
`endDate`	`string · date-time`	Não	—	aceita null
`groupBy`	`SubscriptionConsumptionPeriodGrouping`	Não	—	—
`productType`	`ProductType`	Não	—	—
`userId`	`integer · int32`	Não	—	aceita null
`agentId`	`integer · int32`	Não	—	aceita null
`agentType`	`AgentType`	Não	—	—
`agentAIType`	`AgentAIType`	Não	—	—
`model`	`string`	Não	—	aceita null

Exemplo de requisição

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"
}'

Respostas

Status	Descrição	Corpo da resposta
`200`	Indicadores de consumo.	`application/json` · `ConsumptionDashboardDto`

Exemplo de resposta (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
    }
  ]
}

Modelos de dados

AgentAIType

0 = AzureOpenAI; 1 = OpenAI; 2 = RetellAI; 3 = ElevenLabs; 4 = Lovable; 5 = n8n; 6 = Aws; 7 = MicrosoftCopilot; 8 = GoogleGemini; 9 = AnthropicClaude; 10 = Alteryx

integer

AgentSummaryDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`total`	`integer · int32`	Não	—	—
`active`	`integer · int32`	Não	—	—
`inactive`	`integer · int32`	Não	—	—

AgentType

0 = ZildAssist; 1 = ZildFlow; 2 = ZildInsightChat; 3 = ZildChat; 4 = ZildDocs; 5 = ZildVoice; 6 = ZildCoach; 7 = ZildInsightChecklist

integer

ConsumptionByItemDayDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`date`	`string · date-time`	Não	—	—
`itemName`	`string`	Não	—	aceita null
`quantity`	`number · double`	Não	—	—
`unitMeasure`	`string`	Não	—	aceita null

ConsumptionDashboardDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`agents`	`AgentSummaryDto`	Não	—	—
`contractedVsConsumed`	`ContractedVsConsumedDto`	Não	—	—
`consumptionByItemPerDay`	`array<ConsumptionByItemDayDto>`	Não	—	aceita null
`subscriptionConsumptions`	`array<ConsumptionDimensionDto>`	Não	—	aceita null

ConsumptionDashboardFilterDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`departmentId`	`integer · int32`	Não	—	aceita null
`usageMode`	`TenantUsageMode`	Não	—	—
`isBillable`	`boolean`	Não	—	aceita null
`startDate`	`string · date-time`	Não	—	aceita null
`endDate`	`string · date-time`	Não	—	aceita null
`groupBy`	`SubscriptionConsumptionPeriodGrouping`	Não	—	—
`productType`	`ProductType`	Não	—	—
`userId`	`integer · int32`	Não	—	aceita null
`agentId`	`integer · int32`	Não	—	aceita null
`agentType`	`AgentType`	Não	—	—
`agentAIType`	`AgentAIType`	Não	—	—
`model`	`string`	Não	—	aceita null

ConsumptionDimensionDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`productType`	`ProductType`	Não	—	—
`productTypeName`	`string`	Não	—	aceita null
`productName`	`string`	Não	—	aceita null
`productDescription`	`string`	Não	—	aceita null
`unitMeasure`	`UnitMeasure`	Não	—	—
`periodStart`	`string · date-time`	Não	—	aceita null
`periodEnd`	`string · date-time`	Não	—	aceita null
`quantity`	`number · double`	Não	—	—
`records`	`integer · int32`	Não	—	—
`distinctUsers`	`integer · int32`	Não	—	—
`distinctAgents`	`integer · int32`	Não	—	—
`agentInputTokens`	`integer · int32`	Não	—	—
`agentOutputTokens`	`integer · int32`	Não	—	—
`agentCachedTokens`	`integer · int32`	Não	—	—
`agentReasoningTokens`	`integer · int32`	Não	—	—
`averageResponseTimeInMilliseconds`	`number · double`	Não	—	aceita null

ContractedVsConsumedDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`contractedValue`	`number · double`	Não	—	—
`consumedValue`	`number · double`	Não	—	—
`currency`	`string`	Não	—	aceita null
`consumptionPercentage`	`number · double`	Não	—	—

ProductType

0 = Message; 1 = MessageRepliedByAi; 2 = MessagesUtility; 3 = MessagesMarketing; 4 = TextToSpeech; 5 = SpeechToTextRealTime; 6 = InsightCriteria; 7 = DocsOcrByPage; 8 = DocsOcrImprovementByAIByPage; 9 = CoachByMinute; 10 = CallCostByMinute; 11 = Storage; 13 = SpeechToTextBatch; 15 = ToolCallExecution; 17 = Email; 18 = ImageGeneration; 98 = Implementation; 99 = Other

integer

SubscriptionConsumptionPeriodGrouping

0 = None; 1 = Hour; 2 = Day; 3 = Month

integer

TenantUsageMode

0 = Consumption; 1 = BYOS

integer

UnitMeasure

0 = GB; 1 = Quantity; 2 = Minutes; 3 = Pages

integer