Api/Reports group allows to get reports data.
Basic approach, how to use reports:
- ask
listReports
to get ID-s of your reports - ask
getReportConf
to get details for your report: what parameters it supports, in what format they should be and what other formatting options are available - ask
getReport
to get actual report data
This principle is illustrated in following image:
Requirements
API user must have reports module to get access to those commands, and individually to single reports. You have give access to reports to role, what is attached to API user.
Commands
Api/Reports/listReports
- lists all available reports available to API userApi/Reports/getReportConf (id)
- get details for report parameters, supported and groupable columnsApi/Reports/getReport (id, parameters [,format])
- get report data
Example
Read one example, how to use all three commands in one go in separate page.