Obtener informes

Headers

Authorization

string

The authorization token. Important: This header is required if your environment has the Access Manager plugin enabled.

X-Organization-id

string

The unique identifier of the Organization associated with the request.

Query Parameters

page

integer

Número de página a devolver.

limit

integer

Número de registros devueltos.

status

string

Estado de procesamiento del informe. Valores permitidos: Processing, Finished, Error.

templateID

string

Identificador de la plantilla.

createdAt

string

Fecha y hora en que se creó el informe.

Response

La lista de informes en el sistema.

items

object[]

Información sobre el informe.

Option 1
Option 2

Mostrar atributos secundarios

items.id

string

Identificador único del informe.

items.templateId

string

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

items.filters

object

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

Mostrar atributos secundarios

items.filters.{key}

object

Objeto donde la clave es el identificador exacto de la fuente de datos que se va a filtrar. Utilice el ID de fuente específico configurado en su organización; por ejemplo, use midaz_onboarding para datos de incorporación o plugin_crm para datos de CRM, en lugar de etiquetas genéricas comodatabase_name. Este identificador debe coincidir con el nombre de una fuente de datos conectada y accesible en su entorno. **Importante**: Este objeto es **opcional**, pero si se proporciona, **debe** contener todas las estructuras anidadas necesarias (table,fieldyconditionals`) para garantizar un filtrado válido. Las definiciones de filtro parciales o incompletas generarán un error.

Mostrar atributos secundarios

items.filters.{key}.{key}

object

Objeto obligatorio donde la clave es el nombre exacto de la tabla a filtrar dentro de la fuente de datos seleccionada. Usa el nombre preciso definido en el esquema de la base de datos (por ejemplo, organization, account, transaction o fee), y no un marcador genérico como table_name. Debe coincidir exactamente con una tabla registrada en la fuente de datos seleccionada.

Mostrar atributos secundarios

items.filters.{key}.{key}.{key}

object

Objeto obligatorio donde la clave es el nombre exacto de la columna sobre la que se aplicarán las condiciones de filtrado. Usa el nombre del campo exactamente como está definido en el esquema de la tabla (por ejemplo, accountId, status, createdAt o amount) y no un marcador genérico como field_name. Esta clave debe coincidir exactamente con la columna para asegurar una consulta correcta.

Mostrar atributos secundarios

items.filters.{key}.{key}.{key}.{key}

string[]

Operador(es) lógico(s) que se aplicarán al campo seleccionado. Permiten filtrado avanzado y soportan expresiones simples y compuestas. Operadores admitidos: eq (igual), gt (mayor que), gte (mayor o igual), lt (menor que), lte (menor o igual), between (valor dentro de un rango), in (valor dentro de una lista) y nin (valor fuera de una lista).

Example:

{
  "id": { "eq": ["abc-123"] },
  "createdAt": { "between": ["2024-01-01", "2024-12-31"] }
}

Example:

{
  "account": {
    "id": { "eq": ["abc-123"] },
    "createdAt": { "between": ["2024-01-01", "2024-12-31"] }
  }
}

Example:

{
  "midaz_onboarding": {
    "account": {
      "created_at": { "between": ["2025-08-02", "2025-08-03"] }
    }
  }
}

items.status

enum<string>

Estado del informe.

Opciones disponibles:

Processing,

Finished

items.createdAt

string

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

items.completedAt

string

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

items.updateAt

string

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

items.deletedAt

string

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

items.metadata

object

Objeto que contiene pares clave-valor para agregar como metadatos, donde name es la clave y value es el valor. Por ejemplo, para añadir un centro de costos usa 'costCenter': 'BR_11101997'.

Mostrar atributos secundarios

items.metadata.{key}

string

Templates API

Reports API

Database Mapping API

Error handling

Obtener informes

Headers

Query Parameters

Response