v1
latestOpenAPI 3.0.32026-07-1419076.2 KBGet Reports
This endpoint retrieves all reports available to the client for the given domain. Status will indicate the current status of the report during processing, values include: scheduled, running, completed, error, inactive.
get/reports
Query parameters
domain_idinteger required
The Domain ID used to retrieve reports.
pageinteger
The current page of results to retrieve.
per_pageinteger
The number of results to pull back. Allowed values: 25, 50, 100, -1 (for all).
sortstring
The order for record sorting. Allowed values are asc and desc.
orderstring
The field for sorting records. Allowed values: id, name, scope, type, length, status.
Response
200
Example response
{
"data": [
{
"id": 1,
"name": "Testing Report",
"type": "health_check_export",
"parameters": {
"date_end": "2020-02-13",
"date_start": "2020-02-13"
},
"schedule": {
"run_at": "2020-02-13 05:46:12"
},
"domain_id": 1000,
"status": "scheduled"
}
],
"meta": {
"total": 1,
"count": 1,
"page": 1,
"pages": 1,
"per_page": 25,
"order": "id",
"sort": "DESC"
}
}