# Get Flow dashboard

Get Flow dashboard. See the OpenAPI-defined parameters, request body, and responses below.

Source: https://zild.ai/en-US/docs/api-reference/get-api-Flow-dashboard

GET `/Flow/dashboard`

Get Flow dashboard. See the OpenAPI-defined parameters, request body, and responses below.

## Authentication

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

## Parameters



<table class="api-params"><thead><tr><th>Name</th><th>Location</th><th>Type</th><th>Required</th><th>Description</th><th>Constraints</th></tr></thead><tbody><tr><td><code>FlowId</code></td><td><code>query</code></td><td><code>integer · int32</code></td><td>No</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>No</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>No</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>No</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>No</td><td>—</td><td>—</td></tr><tr><td><code>TaskStatus</code></td><td><code>query</code></td><td><code>FlowTaskStatus</code></td><td>No</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>No</td><td>0 = Day; 1 = Month</td><td>—</td></tr></tbody></table>



## Request body

This operation does not accept a request body.

## Example request



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



## 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>OK</td><td>No response body is defined.</td></tr></tbody></table>



## Data models

`FlowDashboardGrouping`0 = Day; 1 = Month

`integer`

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

`integer`