One report schedule with its recipients.

GET

/reports/subscriptions/{id}

const url = 'https://api.siteqwality.com/reports/subscriptions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <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 https://api.siteqwality.com/reports/subscriptions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

required

string format: uuid

Schedule id

Responses

200

The schedule

application/json

object

required

string format: uuid

name

required

string

kind

required

Which report: the leadership summary, the team’s operations report, or the branded client report.

string

Allowed values: executive operations client_uptime

frequency

required

string

Allowed values: daily weekly monthly

timezone

required

string

send_hour

required

integer format: int32

enabled

required

boolean

next_send_at

When the next report goes out; null while the schedule is turned off.

string | null format: date-time

last_sent_at

string | null format: date-time

created_at

required

string format: date-time

updated_at

required

string format: date-time

recipients

required

Array<object>

object

required

string format: uuid

user_id

Set for a team member.

string | null format: uuid

email

required

string

name

The member’s name, when they have one.

string | null

status

required

A recipient’s state: external addresses stay pending until they confirm.

string

Allowed values: pending active unsubscribed

confirmation_sent_at

string | null format: date-time

Example

{
  "kind": "executive",
  "frequency": "daily",
  "recipients": [
    {
      "status": "pending"
    }
  ]
}

401

Missing or invalid authentication

404

Schedule not found

500

Internal server error