Skip to content
Help Center
Products

API Reference

GET /integration/v1/reports

List reports

List reports

operationId List reports

Query parameters

Name Type Required Description
search string optional Search by report name
_limit integer optional Limit number of results
integer optional Pagination start offset
lang string optional Filter by report language
id string optional Search by report unique identifier
date_insert string optional Search by report creation date (YYYY-MM-DD)
status string optional Search by report status (init, done, error, process)
enum: `init`, `done`, `error`, `process`

Responses

200

application/json body

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

412 Invalid parameters

500 Server error

512 Specification violations