# Query consumption dashboard

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

Source: https://zild.ai/en-US/docs/api-reference/post-api-ConsumptionDashboard

POST `/ConsumptionDashboard`

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`



<table class="api-params"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td><code>departmentId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>usageMode</code></td><td><code>TenantUsageMode</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>isBillable</code></td><td><code>boolean</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>startDate</code></td><td><code>string · date-time</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>endDate</code></td><td><code>string · date-time</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>groupBy</code></td><td><code>SubscriptionConsumptionPeriodGrouping</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>productType</code></td><td><code>ProductType</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>userId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>agentId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>agentType</code></td><td><code>AgentType</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>agentAIType</code></td><td><code>AgentAIType</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>model</code></td><td><code>string</code></td><td>No</td><td>—</td><td>nullable</td></tr></tbody></table>



## 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



<table class="api-params"><thead><tr><th>Status</th><th>Description</th><th>Response body</th></tr></thead><tbody><tr><td><code>200</code></td><td>Indicadores de consumo.</td><td><code>application/json</code> · <code>ConsumptionDashboardDto</code></td></tr></tbody></table>

**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

`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`

<table class="api-params"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td><code>total</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>active</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>inactive</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr></tbody></table>

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

`integer`

`ConsumptionByItemDayDto`

<table class="api-params"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td><code>date</code></td><td><code>string · date-time</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>itemName</code></td><td><code>string</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>quantity</code></td><td><code>number · double</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>unitMeasure</code></td><td><code>string</code></td><td>No</td><td>—</td><td>nullable</td></tr></tbody></table>

`ConsumptionDashboardDto`

<table class="api-params"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td><code>agents</code></td><td><code>AgentSummaryDto</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>contractedVsConsumed</code></td><td><code>ContractedVsConsumedDto</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>consumptionByItemPerDay</code></td><td><code>array&lt;ConsumptionByItemDayDto&gt;</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>subscriptionConsumptions</code></td><td><code>array&lt;ConsumptionDimensionDto&gt;</code></td><td>No</td><td>—</td><td>nullable</td></tr></tbody></table>

`ConsumptionDashboardFilterDto`

<table class="api-params"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td><code>departmentId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>usageMode</code></td><td><code>TenantUsageMode</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>isBillable</code></td><td><code>boolean</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>startDate</code></td><td><code>string · date-time</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>endDate</code></td><td><code>string · date-time</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>groupBy</code></td><td><code>SubscriptionConsumptionPeriodGrouping</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>productType</code></td><td><code>ProductType</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>userId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>agentId</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>agentType</code></td><td><code>AgentType</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>agentAIType</code></td><td><code>AgentAIType</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>model</code></td><td><code>string</code></td><td>No</td><td>—</td><td>nullable</td></tr></tbody></table>

`ConsumptionDimensionDto`

<table class="api-params"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td><code>productType</code></td><td><code>ProductType</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>productTypeName</code></td><td><code>string</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>productName</code></td><td><code>string</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>productDescription</code></td><td><code>string</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>unitMeasure</code></td><td><code>UnitMeasure</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>periodStart</code></td><td><code>string · date-time</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>periodEnd</code></td><td><code>string · date-time</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>quantity</code></td><td><code>number · double</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>records</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>distinctUsers</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>distinctAgents</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>agentInputTokens</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>agentOutputTokens</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>agentCachedTokens</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>agentReasoningTokens</code></td><td><code>integer · int32</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>averageResponseTimeInMilliseconds</code></td><td><code>number · double</code></td><td>No</td><td>—</td><td>nullable</td></tr></tbody></table>

`ContractedVsConsumedDto`

<table class="api-params"><thead><tr><th>Property</th><th>Type</th><th>Required</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td><code>contractedValue</code></td><td><code>number · double</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>consumedValue</code></td><td><code>number · double</code></td><td>No</td><td>—</td><td>—</td></tr><tr><td><code>currency</code></td><td><code>string</code></td><td>No</td><td>—</td><td>nullable</td></tr><tr><td><code>consumptionPercentage</code></td><td><code>number · double</code></td><td>No</td><td>—</td><td>—</td></tr></tbody></table>

`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`