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

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

reportId
integer<int64>
obrigatório

ID do relatório a ser recuperado.

Parâmetros de consulta

archived
boolean
padrão:false

Se deve recuperar um painel arquivado em vez de um ativo. Padrão: falso.

properties
string[]

Propriedades adicionais a serem incluídas na resposta. Os valores válidos são: "dashboardIds", "permissions", "tags".

Resposta

successful operation

archived
boolean
obrigatório

Se o relatório foi arquivado.

businessUnitId
string
obrigatório

O ID da unidade de negócios ao qual o relatório está associado.

createdAt
string<date-time>
obrigatório

A data e a hora em que o relatório foi criado, no formato ISO 8601.

id
string
obrigatório

O ID do relatório.

name
string
obrigatório

O nome do relatório.

updatedAt
string<date-time>
obrigatório

A data e a hora em que o relatório foi atualizado pela última vez, no formato ISO 8601.

archivedAt
string<date-time>

Se o relatório foi arquivado, a data e a hora em que o relatório foi arquivado, no formato ISO 8601. Ausente se o relatório não foi arquivado.

createdByUserId
string

O ID do usuário que criou o relatório. Pode estar ausente.

dashboardIds
string[]

Matriz de IDs dos painéis em que este relatório está.

Para endpoints GET, só é retornada quando solicitada por meio da inclusão do campo "dashboardIds" no parâmetro de consulta "properties". Para outros endpoints, não é retornada.

description
string

Uma descrição do relatório. Pode estar ausente.

lastViewedAt
string<date-time>

A data e a hora em que o relatório foi visualizado pela última vez, no formato ISO 8601. Ausente se ainda não tiver sido visualizado.

lastViewedByUserId
string

O ID do usuário que visualizou o relatório pela última vez. Ausente se ainda não tiver sido visualizado.

ownerUserId
string

O ID do usuário que possui o relatório. Ausente se o relatório não tiver proprietário no momento.

permissions
object
tags
object[]

Matriz de objetos que representam as tags com as quais o relatório está marcado.

Para endpoints GET, é retornado apenas quando solicitado por meio da inclusão do campo "tags" no parâmetro de consulta "properties". Para outros endpoints, é retornado quando aplicável.

updatedByUserId
string

O ID do usuário que atualizou o relatório pela última vez. Pode estar ausente.

Última modificação em 6 de outubro de 2026