Pular para o conteúdo principal
GET
/
v1
/
reports
Recuperar Relatórios
curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/reports \
  --header 'X-Organization-id: <x-organization-id>'
{
  "items": [
    {
      "id": "0196b268-620d-7d09-afa3-85e4d5369eg3",
      "templateId": "0196b264-24d4-7e0b-ad5c-9028cc05138d",
      "filters": null,
      "status": "Processing",
      "completedAt": "2025-05-09T00:18:27.507Z",
      "createdAt": "2025-05-09T00:18:27.469Z",
      "updatedAt": "2025-05-09T00:18:27.469Z",
      "deletedAt": null
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 1
}

Cabeçalhos

​
Authorization
string

O token de autorização no formato 'Bearer '.

Importante: Este header é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

​
X-Organization-id
string
obrigatório

O identificador único da Organização associada à requisição.

Parâmetros de consulta

​
page
integer

Número da página a ser retornada. Deve ser um inteiro maior ou igual a 1.

​
limit
integer

Número de registros retornados. Deve ser um inteiro maior ou igual a 1.

​
sort_order
enum<string>

Direção de ordenação aplicada aos resultados, com base na data de criação. Valores permitidos: asc ou desc. O padrão é desc.

Opções disponíveis:
asc,
desc
​
status
string

O status de processamento do relatório. Valores permitidos: PendingExtraction, Processing, Finished, Error.

​
templateId
string

O identificador do template.

​
createdAt
string

Data em que o relatório foi criado, no formato yyyy-mm-dd.

Resposta

A lista de relatórios no sistema.

​
items
object[]

Lista de relatórios retornados para a página atual.

Informações sobre o relatório.

​
page
integer

Número da página retornada.

​
limit
integer

Número máximo de registros retornados por página.

​
total
integer

Número de registros retornados na página atual.