Skip to main content
PUT

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"

reportId
string
required

Parâmetro do caminho.

Example:

"1"

Body

application/json
segmentBy
string

Eixo de segmentação do relatório.

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"