Semaphor

Get a run's delivery

Returns one scheduled report run and its delivery: each recipient's status and failure, and the attachments the run sent without.

A run can reach some recipients and not others. A recipient that wasn't reached has its own failure; the run's failure says why the run as a whole failed, when it did. An attachment left out is not a failure: show omissions as warnings.

Delivery is recorded for scheduled reports only. Exports have no recipients: read an export with Get an export.

GET
/api/v1/briefings/{briefingId}/runs/{runId}/delivery

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

briefingId*string

The scheduled report's ID (a run's ruleId).

runId*string

The run's ID.

Response Body

application/json

application/json

application/json

curl -X get "https://semaphor.cloud/api/v1/briefings/string/runs/string/delivery"
{
  "run": {
    "id": "string",
    "ruleId": "string",
    "status": "QUEUED",
    "scheduledFor": "2019-08-24T14:15:22Z",
    "startedAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "failure": {
      "code": "cancelled",
      "message": "Something went wrong while running this report. Try again, and contact support if it keeps happening.",
      "detail": "string"
    },
    "error": "string",
    "requestId": "string",
    "attempt": 0
  },
  "delivery": {
    "deliveries": [
      {
        "channel": "EMAIL",
        "recipient": "string",
        "status": "SENT",
        "failure": {
          "code": "email_not_set_up",
          "message": "The email to ops@example.com couldn't be sent. The next run will try again; contact support if it keeps happening.",
          "detail": "string"
        },
        "error": "string",
        "at": "2019-08-24T14:15:22Z"
      }
    ],
    "omissions": [
      {
        "code": "PDF_ROW_LIMIT_EXCEEDED",
        "format": "pdf",
        "title": "string",
        "reason": "Revenue by region (PDF) isn't attached. It has more than 5,000 rows, more than a PDF can hold. Switch this attachment to CSV to receive every row."
      }
    ]
  }
}
{
  "error": "string"
}
{
  "error": "string"
}