# Consultar dashboard de documentos

Este endpoint retorna informações resumidas e estatísticas dos documentos para exibição em dashboard. Permite filtrar por período (createdAtStart e createdAtEnd).

Source: https://zild.ai/pt-BR/docs/api-reference/get-api-Document-dashboard

GET `/Document/dashboard`

Este endpoint retorna informações resumidas e estatísticas dos documentos para exibição em dashboard. Permite filtrar por período (createdAtStart e createdAtEnd).

## Autenticação

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

## Parâmetros



<table class="api-params"><thead><tr><th>Nome</th><th>Local</th><th>Tipo</th><th>Obrigatório</th><th>Descrição</th><th>Restrições</th></tr></thead><tbody><tr><td><code>CreatedAtStart</code></td><td><code>query</code></td><td><code>string · date-time</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>CreatedAtEnd</code></td><td><code>query</code></td><td><code>string · date-time</code></td><td>Não</td><td>—</td><td>—</td></tr></tbody></table>



## Corpo da requisição

Esta operação não recebe corpo de requisição.

## Exemplo de requisição



```
curl --request GET \
  --url 'https://api.zild.ai/Document/dashboard?CreatedAtStart={CreatedAtStart}&CreatedAtEnd={CreatedAtEnd}' \
  --header 'X-API-Key: YOUR_USER_API_KEY'
```



## Respostas



<table class="api-params"><thead><tr><th>Status</th><th>Descrição</th><th>Corpo da resposta</th></tr></thead><tbody><tr><td><code>200</code></td><td>Sucesso ao retornar o dashboard</td><td><code>application/json</code> · <code>DocumentDashboardDto</code></td></tr></tbody></table>

**Exemplo de resposta (200):**



```
{
  "total": 0,
  "new": 0,
  "inProgress": 0,
  "approved": 0,
  "rejected": 0,
  "completed": 0,
  "cancelled": 0,
  "quantityPagesProcessed": 0,
  "successRate": 0,
  "dailyExecutions": [
    {
      "date": "string",
      "total": 0,
      "new": 0,
      "inProgress": 0,
      "approved": 0,
      "rejected": 0,
      "completed": 0,
      "cancelled": 0
    }
  ]
}
```



## Modelos de dados

`DocumentDailyCountDto`

<table class="api-params"><thead><tr><th>Propriedade</th><th>Tipo</th><th>Obrigatório</th><th>Descrição</th><th>Restrições</th></tr></thead><tbody><tr><td><code>date</code></td><td><code>string</code></td><td>Não</td><td>—</td><td>aceita null</td></tr><tr><td><code>total</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>new</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>inProgress</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>approved</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>rejected</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>completed</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>cancelled</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr></tbody></table>

`DocumentDashboardDto`

<table class="api-params"><thead><tr><th>Propriedade</th><th>Tipo</th><th>Obrigatório</th><th>Descrição</th><th>Restrições</th></tr></thead><tbody><tr><td><code>total</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>new</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>inProgress</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>approved</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>rejected</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>completed</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>cancelled</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>quantityPagesProcessed</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>successRate</code></td><td><code>number · double</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>dailyExecutions</code></td><td><code>array&lt;DocumentDailyCountDto&gt;</code></td><td>Não</td><td>—</td><td>aceita null</td></tr></tbody></table>