Reporting APIs
Use the methods in the following table to retrieve and generate reports.
HTTP Method | Path | Description |
---|---|---|
|
|
Retrieve all list of reports. |
|
|
Retrieve a report. |
Retrieve a list of reports
Use the method listed in the following table to retrieve a list of reports.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Retrieve all available reports for a tenant. |
|
Required request body attributes: none
Request body example:
none
Response body example:
{ "status": { "user_message": "string", "verbose_message": "string", "code": "string" }, "result": { "returned_records": 1, "records": [ { "filename": "string" } ] } }
Retrieve a report identified by file name
Use the method in the following table to retrieve a report identified by the file name.
HTTP Method | Path | Description | Parameters |
---|---|---|---|
|
|
Retrieve a report identified by the file name. |
|
Required request body attributes: none
Request body example:
none
Response body example:
{ "status": { "user_message": "string", "verbose_message": "string", "code": "string" }, "result": { "total_records": 1, "records": [ { "filename": "string" } ] } }