Saltar al contenido
Centro de ayuda
Productos

Referencia de la API

GET /integration/v1/reports

List reports

List reports

operationId List reports

Parámetros de consulta

Nombre Tipo Obligatorio Descripción
search string opcional Search by report name
_limit integer opcional Limit number of results
integer opcional Pagination start offset
lang string opcional Filter by report language
id string opcional Search by report unique identifier
date_insert string opcional Search by report creation date (YYYY-MM-DD)
status string opcional Search by report status (init, done, error, process)
enum: `init`, `done`, `error`, `process`

Respuestas

200

Cuerpo de application/json

Campo Tipo Obligatorio Descripción
(array) array opcional Reports data
id string obligatorio Report unique identifier
account_id string (uuid) obligatorio Account unique identifier
api_user_id string (uuid) obligatorio API user unique identifier
name string obligatorio Report name
full_name string obligatorio Full descriptive report name
date_insert string (date) obligatorio Date when the report entry was created
date_start string (date) obligatorio Start date of the report period
date_end string (date) obligatorio End date of the report period
status string obligatorio Current report status (init, process, done, error)
is_auto_generated integer obligatorio Flag indicating whether the report was auto generated
has_html_view integer obligatorio Flag indicating whether the report has an HTML view
rows_count integer obligatorio Number of rows generated in the report
input_data object obligatorio Original input data used to generate the report
output_data_columns object obligatorio List of output data columns generated by the report
output_data_specs object obligatorio Detailed specifications for the output structure
filename string obligatorio Generated report output filename
errors object obligatorio List of report generation errors if any
Record_Creation_Date string (date) obligatorio Timestamp when the report was created in the system
file_status string opcional Derived availability status of the generated report file

412 Invalid parameters

500 Server error

512 Specification violations