Pular para o conteúdo principal
POST
/
v1
/
reports
Criar um Relatório
curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-id: <x-organization-id>' \
  --data '
{
  "templateId": "01953d09-e6cb-7c1c-a01a-272855a9ffb7",
  "filters": {
    "midaz_onboarding": {
      "account": {
        "created_at": {
          "between": [
            "2025-08-02",
            "2025-08-03"
          ]
        }
      }
    }
  }
}
'
{
  "id": "0196c5c0-5044-724f-95f3-4b32076e7ad7",
  "templateId": "01953d09-e6cb-7c1c-a01a-272855a9ffb7",
  "filters": {
    "midaz_onboarding": {
      "account": {
        "created_at": {
          "between": [
            "2025-08-02",
            "2025-08-03"
          ]
        }
      }
    }
  },
  "status": "Processing",
  "completedAt": null,
  "createdAt": "2025-05-12T18:27:17.188156815Z",
  "updatedAt": "2025-05-12T18:27:17.188156815Z",
  "deletedAt": null
}

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.

​
X-Idempotency
string

Chave de idempotência opcional para retentativas seguras. Se omitida, o servidor pode gerar uma automaticamente.

Consulte Retentativas e idempotência para mais detalhes.

Corpo

application/json

Detalhes da requisição para gerar o relatório.

​
templateId
string
obrigatório

Identificador único do template usado para gerar o relatório.

​
filters
object
obrigatório

Objeto que define os critérios de filtragem aplicados aos dados usados no relatório. Agora suporta operadores de filtragem avançados incluindo equality, comparison, range e condições baseadas em lista.

Importante: O objeto filters deve ser incluído no corpo da requisição, mesmo que esteja vazio.

Resposta

Indica que a requisição de relatório foi criada com sucesso.

A resposta inclui o header X-Idempotency-Replayed.

Se o valor for false, a requisição foi recém-processada. Se o valor for true, a resposta é uma repetição de uma requisição processada anteriormente.

Consulte Retentativas e idempotência para mais detalhes.

Detalhes sobre o relatório que foi criado.

​
id
string

Identificador único da requisição de geração de relatório.

​
templateId
string

Identificador único do template usado para gerar o relatório.

​
templateOutputFormat
string

Formato de saída configurado no template usado para gerar o relatório.

Exemplo:

"XML"

​
templateDescription
string

Descrição configurada no template usado para gerar o relatório.

Exemplo:

"Cadoc"

​
filters
object

Objeto que define os critérios de filtragem aplicados aos dados usados no relatório. Agora suporta operadores de filtragem avançados incluindo equality, comparison, range e condições baseadas em lista.

​
status
string

Status atual do relatório

​
completedAt
string

Timestamp indicando quando o processamento do relatório foi concluído.

​
createdAt
string

Timestamp indicando quando esta requisição de relatório foi criada.

​
updatedAt
string

Timestamp indicando a última atualização desta requisição de relatório.

​
deletedAt
string

Timestamp indicando quando esta requisição de relatório foi excluída logicamente, se aplicável.

​
metadata
object

Um objeto contendo informações adicionais sobre o relatório como pares chave-valor. Os valores podem ser strings simples ou objetos aninhados. Para relatórios que falharam, este objeto inclui uma entrada error descrevendo a falha (code, title, message e details).