Pular para o conteúdo principal
GET
Obter um relatório

Autorizações

Authorization
string
header
obrigatório

Token bearer JWT emitido pelo provedor de identidade.

Parâmetros de caminho

id
string
obrigatório

ID do relatório

Resposta

OK

completedAt
string<date-time> | null

Hora em que a geração do relatório foi concluída, quando disponível.

Exemplo:

"2026-01-31T15:04:05Z"

createdAt
string<date-time>

Hora em que o relatório foi criado.

Exemplo:

"2026-01-31T15:00:00Z"

deletedAt
string<date-time> | null

Hora em que o relatório foi excluído de forma lógica, quando aplicável.

Exemplo:

"2026-02-01T09:00:00Z"

filters
object

Condições de filtro agrupadas por fonte de dados, tabela e campo.

Exemplo:
id
string

Identificador estável do relatório.

Exemplo:

"00000000-0000-0000-0000-000000000001"

metadata
object

Metadados adicionais do relatório, indexados pelo nome do atributo.

Exemplo:
status
string

Status atual da geração do relatório.

Exemplo:

"Processing"

templateDescription
string

Descrição copiada do template quando o relatório foi criado.

Exemplo:

"Monthly accounting report"

templateId
string

Identificador de origem do snapshot do template.

Exemplo:

"00000000-0000-0000-0000-000000000002"

templateOutputFormat
string

Formato de saída selecionado para o relatório gerado.

Exemplo:

"pdf"

updatedAt
string<date-time>

Hora da última atualização do relatório.

Exemplo:

"2026-01-31T15:04:05Z"