List runs
Returns one page of runs, newest first, scheduled between since and
until (the last 24 hours by default).
kind | Returns |
|---|---|
BRIEFING | Scheduled report runs |
EXPORT | Export runs |
CACHE_REFRESH | Data refresh runs |
| omitted | Export and data refresh runs |
Which runs a token sees:
| Token identifies | Scheduled report runs | Export and data refresh runs |
|---|---|---|
| Organization Admin | Every report in the project | Every one in the project |
| Other organization user | Every report in the project | The ones they created |
| Tenant user | Reports they created in their tenant | Their tenant's |
To read which recipients a scheduled report run reached, call
Get a run's delivery
with its ruleId and id.
Authorization
BearerAuth A project-scoped access token. Generate one via the Token API with your project ID and project secret.
In: header
Query Parameters
The project to list. It must match the token's project; leave it out to use the token's project.
Only runs of this kind. Case does not matter.
"BRIEFING" | "EXPORT" | "CACHE_REFRESH"Only runs with this status. Case does not matter.
"QUEUED" | "RUNNING" | "SUCCESS" | "FAILED"Only runs of this scheduled report or export (its ruleId).
Only runs scheduled at or after this time (ISO 8601). Defaults to 24 hours ago.
date-timeOnly runs scheduled at or before this time (ISO 8601). Defaults to now.
date-timePage number, starting at 1.
11 <= value <= 10000Runs per page.
501 <= value <= 200Response Body
application/json
application/json
application/json
application/json
curl -X get "https://semaphor.cloud/api/v1/automations/runs"{
"runs": [
{
"id": "string",
"ruleId": "string",
"ruleName": "string",
"ruleKind": "BRIEFING",
"status": "QUEUED",
"scheduledFor": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"durationMs": 0,
"failure": {
"code": "cancelled",
"message": "Something went wrong while running this report. Try again, and contact support if it keeps happening.",
"detail": "string"
},
"error": "string",
"deliverySummary": {
"total": 0,
"sent": 0,
"failed": 0,
"pending": 0
}
}
],
"total": 0,
"page": 0,
"pageSize": 0
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}