Skip to main content
POST

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir o JWT da conta no header Authorization no formato Bearer. Sem esse header a requisição é recusada.

Path Parameters

companyId
string
required

Empresa da sessão.

Example:

"UUID_DA_EMPRESA"

userId
string
required

Usuário da sessão.

Example:

"UUID_DO_USUARIO"

Body

application/json
title
string
required

Título.

Example:

"Tarefa de exemplo"

entity
enum<string>
required

Nome da entidade consultável.

Available options:
project,
called,
task,
milestone,
team
Example:

"project"

measureBy
string
required

Obrigatório no corpo.

Example:

"exemplo"

viewBy
string
required

Obrigatório no corpo.

Example:

"exemplo"

period
enum<string>
required

Obrigatório no corpo.

Available options:
Daily,
Weekly,
Monthly,
Quarterly,
Yearly
Example:

"Daily"

filters
string[]
required

filters com id, field, operator e um valor preenchido

Example:
segmentBy
enum<string>

Eixo de segmentação do relatório.

Available options:
Status,
Owner,
Type,
Priority,
Board,
Project
Example:

"Status"

chartType
string

Tipo do gráfico.

Example:

"exemplo"

Response

A operação concluiu. success é true, code é SUCCESS e o conteúdo vem em data.

success
boolean
required
Example:

true

data
any
required

Conteúdo da operação. O exemplo 200 de cada rota preenche os campos do recurso.

code
string
required
Example:

"SUCCESS"