# Consultar dashboard do Flow

Consultar dashboard do Flow. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.

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

GET `/Flow/dashboard`

Consultar dashboard do Flow. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.

## 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>FlowId</code></td><td><code>query</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>TaskCreatedAtStart</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>TaskCreatedAtEnd</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>TaskCompletedAtStart</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>TaskCompletedAtEnd</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>TaskStatus</code></td><td><code>query</code></td><td><code>FlowTaskStatus</code></td><td>Não</td><td>0 = Pending; 1 = InProgress; 2 = Completed; 3 = Canceled</td><td>—</td></tr><tr><td><code>Grouping</code></td><td><code>query</code></td><td><code>FlowDashboardGrouping</code></td><td>Não</td><td>0 = Day; 1 = Month</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/Flow/dashboard?FlowId={FlowId}&TaskCreatedAtStart={TaskCreatedAtStart}&TaskCreatedAtEnd={TaskCreatedAtEnd}&TaskCompletedAtStart={TaskCompletedAtStart}&TaskCompletedAtEnd={TaskCompletedAtEnd}&TaskStatus={TaskStatus}&Grouping={Grouping}' \
  --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>OK</td><td>Nenhum corpo de resposta está definido.</td></tr></tbody></table>



## Modelos de dados

`FlowDashboardGrouping`0 = Day; 1 = Month

`integer`

`FlowTaskStatus`0 = Pending; 1 = InProgress; 2 = Completed; 3 = Canceled

`integer`