Skip to content
Site Qwality Site Qwality Site Qwality Docs

List heartbeat monitors.

GET
/v1/heartbeat-monitors
 
curl --request GET \
  --url https://api.siteqwality.com/v1/heartbeat-monitors \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
cursor
string

next_cursor from the previous page.

limit
integer format: int64

1 to 200, default 50.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The account’s heartbeat monitors, newest first

Media type application/json

{"data": [...], "next_cursor": ...}; the /v1 shaping keeps it as is.

object
data
required
Array<object>
object
id
required
string format: uuid
account_id
required
string format: uuid
created_at
required
string format: date-time
current_status
required
string
Allowed values: success failed
friendly_name
string | null
last_received_at
string | null format: date-time
last_status_change_at
string | null format: date-time
last_checked_at
string | null format: date-time
check_interval_seconds
required
integer format: int32
grace_seconds

Extra seconds after the interval before a missing ping alerts. 0 alerts as soon as the interval passes.

integer format: int32
group_notification_ids
array | null
group_notifications
array | null
object
id
required
string format: uuid
account_id
required
string format: uuid
friendly_name
required
string
delay_send_after_minutes
integer | null format: int32
resend_every_minutes
integer | null format: int32
is_default

The group monitors get when they are created without group_notification_ids.

boolean
created_at
required
string format: date-time
notifications
required
Array<object>
object
id
required
string format: uuid
account_id
required
string format: uuid
type
required
string
Allowed values: email sms slack webhook telegram discord microsoft_teams pagerduty opsgenie google_chat mattermost pushover pushbullet
details
required
One of:
object
email_address
required
string
created_at
required
string format: date-time
health
One of:

How this channel’s recent deliveries went: whether the last alert reached anyone, and why not when it did not (a revoked Slack token, a bouncing inbox). Present on the read endpoints; absent on create and update responses.

object
state
required

healthy: the most recent delivery reached the provider. degraded: it was refused, bounced, complained about, could not be sent, or skipped for a reason the channel must fix (such as sms_quota), so the next alert will likely not arrive either. unknown: nothing sent in the lookback window. A skip by design, such as heartbeat_channel_unsupported, is listed in recent but never judged.

string
recent
required

Newest first, at most [CHANNEL_HEALTH_RECENT].

Array<object>

One delivery, as a channel’s health shows it.

object
at
required
string format: date-time
status
required

Sent | delivered | delayed | soft_bounced | failed | rejected | bounced | complained | skipped

string
reason

The provider’s reason for a non-success status, URLs reduced to hosts. For skipped, a slug such as sms_quota or tls_channel_unsupported.

string | null
bouncing
One of:

An email channel whose address hard-bounced or complained after its last delivery: SES now suppresses it, so the channel is degraded until the address is fixed.

object
since
required
string format: date-time
event_type
required

bounce or complaint.

string
sub_type

E.g. Permanent/General, Permanent/OnAccountSuppressionList.

string | null
numb_of_sites
integer | null format: int64
state
required
string
Allowed values: active paused
paused_reason

Why a paused monitor is paused: user or dormancy (older rows may say billing).

string | null
tags
array | null
service_id
string | null format: uuid
next_cursor

Send back as cursor for the next page; null on the last one.

string | null
Example 
{
  "data": [
    {
      "current_status": "success",
      "group_notifications": [
        {
          "notifications": [
            {
              "type": "email",
              "details": {
                "pagerduty_severity": "critical"
              }
            }
          ]
        }
      ],
      "state": "active"
    }
  ]
}

400

Section titled “400 ”

Invalid limit or cursor

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

401

Section titled “401 ”

Missing or invalid credentials

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

403

Section titled “403 ”

The key or member may not do this, or lacks the scope it needs

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

429

Section titled “429 ”

Too many requests; wait for the time in Retry-After

Media type application/problem+json

An RFC 9457 problem, the body of every /v1 error.

object
type
required

https://docs.siteqwality.com/errors/ and the failure’s code, such as not_found.

string
title
required
string
status
required
integer format: int32
detail
string | null
instance

urn:uuid: and the request id.

string | null
errors

The invalid fields, when the request body was refused.

array | null

One validation failure; pointer is an RFC 6901 pointer into the request body.

object
pointer
required
string
detail
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "pointer": "example",
      "detail": "example"
    }
  ]
}

Privacy Cookie preferences