Pular para o conteúdo principal
GET
Obter painel

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

dashboardId
integer<int64>
obrigatório

O ID do painel a ser recuperado.

Parâmetros de consulta

archived
boolean
padrão:false

Recuperar ou não 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: "permissions", "tags", "widgets", "widgets.report".

Resposta

successful operation

archived
boolean
obrigatório

Se o painel foi arquivado.

businessUnitId
string
obrigatório

O ID da unidade de negócios à qual o painel está associado.

createdAt
string<date-time>
obrigatório

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

id
string
obrigatório

O ID do painel.

name
string
obrigatório

O nome do painel.

updatedAt
string<date-time>
obrigatório

Data e hora da última atualização do painel, no formato ISO 8601.

archivedAt
string<date-time>

Se o painel foi arquivado, a data e a hora em que isso aconteceu, no formato ISO 8601. Ausente se o painel não foi arquivado.

createdByUserId
string

ID do usuário que criou o painel. Pode estar ausente.

description
string

Uma descrição do painel. Pode estar ausente.

lastViewedAt
string<date-time>

A data e a hora em que o painel 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 painel pela última vez. Ausente se ainda não tiver sido visualizado.

ownerUserId
string

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

permissions
object
tags
object[]

Matriz de objetos que representam as tags com as quais o painel 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 painel pela última vez. Pode estar ausente.

widgets
object[]

Uma matriz de objetos que representam os widgets no painel.

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

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