List report runs REST API

GET

/api/reports/{report_id}/runs

const url = 'http://127.0.0.1:25737/api/reports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/runs';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://127.0.0.1:25737/api/reports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/runs \
  --cookie hk_token=<hk_token>

Lists recent runs and recipient delivery outcomes without rendered bodies or raw SMTP errors.

Authorizations

cookieAuth

Parameters

Path Parameters

report_id

required

string format: uuid

Report definition UUID.

Responses

200

Report runs

application/json

Array<object>

object

deliveries

Array<object>

object

attempt_count

integer

string format: uuid

next_attempt_at

string format: date-time

recipient_email

string format: email

recipient_id

string format: uuid

recipient_kind

string

Allowed values: member external

recipient_user_id

string format: uuid

safe_error_code

string

smtp_accepted_at

string format: date-time

status

string

string format: uuid

period_end

string format: date-time

period_start

string format: date-time

report_id

string format: uuid

safe_error_code

string

scheduled_for

string format: date-time

status

string

Example

[
  {
    "deliveries": [
      {
        "recipient_kind": "member"
      }
    ]
  }
]