Semaphor

List runs

Returns one page of runs, newest first, scheduled between since and until (the last 24 hours by default).

kindReturns
BRIEFINGScheduled report runs
EXPORTExport runs
CACHE_REFRESHData refresh runs
omittedExport and data refresh runs

Which runs a token sees:

Token identifiesScheduled report runsExport and data refresh runs
Organization AdminEvery report in the projectEvery one in the project
Other organization userEvery report in the projectThe ones they created
Tenant userReports they created in their tenantTheir tenant's

To read which recipients a scheduled report run reached, call Get a run's delivery with its ruleId and id.

GET
/api/v1/automations/runs

Authorization

BearerAuth
AuthorizationBearer <token>

A project-scoped access token. Generate one via the Token API with your project ID and project secret.

In: header

Query Parameters

projectId?string

The project to list. It must match the token's project; leave it out to use the token's project.

kind?string

Only runs of this kind. Case does not matter.

Value in"BRIEFING" | "EXPORT" | "CACHE_REFRESH"
status?string

Only runs with this status. Case does not matter.

Value in"QUEUED" | "RUNNING" | "SUCCESS" | "FAILED"
ruleId?string

Only runs of this scheduled report or export (its ruleId).

since?string

Only runs scheduled at or after this time (ISO 8601). Defaults to 24 hours ago.

Formatdate-time
until?string

Only runs scheduled at or before this time (ISO 8601). Defaults to now.

Formatdate-time
page?integer

Page number, starting at 1.

Default1
Range1 <= value <= 10000
pageSize?integer

Runs per page.

Default50
Range1 <= value <= 200

Response 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"
}