HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Generar Report

Genera el reporte de la entidad indicada y devuelve las URLs firmadas para descargarlo.

Aplica los filtros del payload, exporta el resultado en el formato pedido (xlsx por defecto o csv) y deja los archivos en almacenamiento. La respuesta trae el identificador de la ejecución del reporte, la URL del archivo principal, las URLs de todos los archivos generados y, para las entidades que lo ofrecen, un resumen agregado del contenido.

Si el payload incluye user_email o external_emails, además se envía el reporte por correo a esas direcciones. Cuando la consulta no arroja registros la operación responde 204 sin cuerpo y, de haber destinatarios, les avisa por correo que el reporte quedó vacío.

Con export_format=csv y varias hojas, csv_export_strategy decide la forma de entrega: zip empaqueta todas las hojas en un archivo, single_sheet exporta solo la hoja de csv_target_sheet, e individual genera un CSV por hoja y es incompatible con el envío por correo. El identificador de la ejecución permite consultar después su estado en /report-executions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Entidad sobre la que se genera el reporte.

Body Params
string
length between 1 and 1
Defaults to ;

Single ASCII field delimiter for CSV export. Default: semicolon.

string
enum
Defaults to zip

Cómo se entregan las hojas de un reporte exportado a CSV: zip las empaqueta en un archivo comprimido, con un CSV por hoja; individual entrega un CSV suelto por hoja, cada uno con su propia URL; y single_sheet entrega un único CSV con la hoja indicada en csv_target_sheet. Solo tiene efecto cuando el formato de exportación es csv.

Allowed:
string
custom_params
object
string
enum
exclude
array of strings
Exclude
string
enum
Defaults to xlsx

Formato del archivo que se genera: xlsx entrega un solo libro, con una hoja por cada hoja del reporte, y csv entrega archivos planos, cuya cantidad y empaquetado dependen de csv_export_strategy.

Allowed:
external_emails
array of strings

Additional email addresses to receive the report (optional). Combined with user_email for notification.

External Emails
filters
array of objects
Filters
header_metadata
object
boolean
Defaults to false
boolean
Defaults to false
string
integer
Defaults to 0
string
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json