Reports
List Scheduled Report Runs by Report
List Scheduled Report Runs for a specific scheduled report (all statuses: IN_PROGRESS, SUCCESS, FAILED).
Sample Request
curl -X GET https://console.jumpcloud.com/api/v2/reports/scheduled/{id}/runs \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
get/api/v2/reports/scheduled/{objectId}/runs
Request
- Base URLhttps://console.jumpcloud.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
objectIdstring required
object_id path param (scheduled_reports.id, UUID)
Query parameters
limitstring int64
The number of records to return at once. Limited to 100.
skipstring int64
The offset into the records to return.
sortstring
Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with - to sort descending.
filterstring[]
A filter to apply to the query.
**Filter structure**: `<field>:<operator>:<value>`.
**field** = Populate with a valid field from an endpoint response.
**operator** = Supported operators are: eq, ne, gt, ge, lt, le, search, in.
**value** = Populate with the value you want to search for. Is case sensitive. Supports wild cards.
**Example** `GET /api/v2/reports/scheduled/{id}/runs?filter=status:eq:SUCCESS`
startDatestring date-time
Inclusive start of completed_at range for history filtering (RFC3339).
endDatestring date-time
Inclusive end of completed_at range for history filtering (RFC3339).
Response
Success listing Scheduled Report Runs for a report.
Changes
No recorded changes to this operation across all 1 revision of this API.