Consultar dashboard do Flow

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

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

Nome	Local	Tipo	Obrigatório	Descrição	Restrições
`FlowId`	`query`	`integer · int32`	Não	—	—
`TaskCreatedAtStart`	`query`	`string · date-time`	Não	—	—
`TaskCreatedAtEnd`	`query`	`string · date-time`	Não	—	—
`TaskCompletedAtStart`	`query`	`string · date-time`	Não	—	—
`TaskCompletedAtEnd`	`query`	`string · date-time`	Não	—	—
`TaskStatus`	`query`	`FlowTaskStatus`	Não	0 = Pending; 1 = InProgress; 2 = Completed; 3 = Canceled	—
`Grouping`	`query`	`FlowDashboardGrouping`	Não	0 = Day; 1 = Month	—

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

Status	Descrição	Corpo da resposta
`200`	OK	Nenhum corpo de resposta está definido.

Modelos de dados

FlowDashboardGrouping

0 = Day; 1 = Month

integer

FlowTaskStatus

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

integer