Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Dados do relatório a ser criado

target
object
required
template
string
required

ID do template no formato tpl_$nanoid

Pattern: ^tpl_[a-zA-Z0-9_-]+$
Example:

"tpl_abc123def456"

Response

200 - application/json

Relatório criado com sucesso

id
string

ID do relatório

uploadUrl
string

URL S3 assinada para upload

status
enum<string>

Status do relatório

Available options:
pending,
processing,
completed,
error
target
object
template
string
sections
object[]

Seções do relatório com conteúdo estruturado

Example:
createdAt
string<date-time>
updatedAt
string<date-time>
createdBy
string
updatedBy
string