Pular para o conteúdo principal
GET
Pesquisar relatórios

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 consulta

after
string

Um token de cursor para paginação. Use o valor do campo paging.next.after da resposta anterior.

archived
boolean

Deve-se recuperar apenas relatórios arquivados. Padrão: falso.

businessUnitIds
string[]

Filtre relatórios que fazem parte das unidades de negócio especificadas.

createdAfter
string<date-time>

Filtrar relatórios criados após uma data e hora específica.

createdBefore
string<date-time>

Filtrar relatórios criados antes de uma data e hora específicas.

dashboardId
string

Filtre relatórios no painel especificado.

ids
string[]

Filtre relatórios com os IDs especificados.

limit
integer<int32>

O número máximo de resultados a serem exibidos por página. Padrão 25, máximo 100.

onDashboard
boolean

Filtre relatórios que estão, ou não estão, em qualquer painel. Desativado por padrão.

onlyFavorites
boolean

Filtre apenas para relatórios favoritados pelo usuário solicitante. Padrão: falso.

ownerUserIds
string[]

Filtre relatórios de propriedade dos usuários especificados.

properties
string[]

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

q
string

Filtre relatórios cujo nome ou descrição contenha a string de pesquisa.

sort
string[]

Selecione o campo e a direção. Os campos compatíveis são name, updatedAt e lastViewedAt. O padrão é -updatedAt

tagIds
string[]

Filtre relatórios marcados com as tags especificadas.

updatedAfter
string<date-time>

Filtrar relatórios atualizados após uma data e hora específicas.

updatedBefore
string<date-time>

Filtrar relatórios atualizados antes de uma data e hora específicas.

Resposta

successful operation

results
object[]
obrigatório

Uma matriz de objetos de relatório.

total
integer<int32>
obrigatório

O número total de relatórios disponíveis.

paging
object

Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados.

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