Saltar al contenido principal
POST
/
v1
/
reports
Crear un informe
curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/reports \
  --header 'Content-Type: application/json' \
  --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
}

Encabezados

​
Authorization
string

El token de autorización en formato 'Bearer '.

Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

​
X-Organization-id
string

The unique identifier of the Organization associated with the request.

​
X-Idempotency
string

Clave de idempotencia opcional que el cliente debe reutilizar cuando reintente exactamente la misma operación.

Si se omite, la solicitud se procesa normalmente, pero no debe asumirse deduplicación entre reintentos a menos que la API devuelva explícitamente la clave generada.

Consulte Reintentos e idempotencia para más detalles.

Cuerpo

application/json

Detalles de la solicitud para generar el informe.

​
templateId
string
requerido

Identificador único de la plantilla usada para generar el informe.

​
filters
object
requerido

Objeto que define los criterios de filtrado aplicados a los datos del informe. Ahora admite operadores de filtrado avanzados, como equality, comparison, range, y condiciones basadas en listas.

Importante: El objeto filters debe incluirse en el cuerpo de la solicitud, incluso si está vacío.

Respuesta

Indica que la solicitud de reporte se creó correctamente.

La respuesta incluye el header X-Idempotency-Replayed.

Si el valor es false, la solicitud fue recién procesada. Si el valor es true, la respuesta es una repetición de una solicitud procesada anteriormente.

Consulte Reintentos e idempotencia para más detalles.

Detalles del informe que se creó.

​
id
string

Unique identifier of the report generation request.

​
templateId
string

Identificador único de la plantilla usada para generar el informe.

​
templateOutputFormat
string

Formato de salida configurado en la plantilla usada para generar el informe.

Ejemplo:

"XML"

​
templateDescription
string

Descripción configurada en la plantilla usada para generar el informe.

Ejemplo:

"Cadoc"

​
filters
object

Object that defines the filtering criteria applied to the data used in the report. Now supports advanced filtering operators including equality, comparison, range, and list-based conditions.

​
status
string

Estado actual del informe

​
completedAt
string

Marca de tiempo que indica cuándo se completó el procesamiento del informe.

​
createdAt
string

Marca de tiempo que indica cuándo se creó esta solicitud de informe.

​
updatedAt
string

Marca de tiempo de la última actualización de esta solicitud de informe.

​
deletedAt
string

Marca de tiempo que indica cuándo esta solicitud de informe se eliminó lógicamente, si aplica.

​
metadata
object

Objeto que contiene información adicional sobre el informe como pares clave-valor. Los valores pueden ser cadenas simples u objetos anidados. Para informes fallidos, este objeto incluye una entrada error que describe la falla (código, título, mensaje y detalles).