Skip to content
Site Qwality Site Qwality Site Qwality Docs

Show a browser monitor on a status page.

POST
/v1/status-pages/{status_page_id}/browser-monitors/{browser_monitor_id}
 
curl --request POST \
  --url https://api.siteqwality.com/v1/status-pages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/browser-monitors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "friendly_name": "example" }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
status_page_id
required
string format: uuid
browser_monitor_id
required
string format: uuid

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string
<= 255 characters

Makes a retry safe: the same key and body within 24 hours returns the first response with Idempotent-Replayed: true. The same key with another body is refused with 422 idempotency_key_reused, and one still running with 409 idempotency_key_in_use.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
friendly_name
required
string
Example generated
{
  "friendly_name": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

The monitor is on the page

Media type application/json
object
account_id
required
string
status_page_id
required
string
browser_check_id
required
string
friendly_name
required
string
sla_target_percentage
number | null format: double
browser_check
One of:
object
id
required
string format: uuid
account_id
required
string format: uuid
name
required
string
script
required
string
frequency
required
string
timeout_seconds
required
integer format: int32
check_regions
required
Array<string>
min_healthy_regions
required
integer format: int32
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
current_status
required
string
Allowed values: success failed pending_failure
last_run_at
string | null format: date-time
last_status_change_at
string | null format: date-time
group_notifications

Notification groups resolved from group_notification_ids. This is what the dashboard edit form seeds from.

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
service_id
string | null format: uuid
tags
array | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
confirmation_threshold

Consecutive failed runs before DOWN; null means 1.

integer | null format: int32
rerun_on_failure

Whether a failed run is rerun once from the same location before it counts; null means off.

boolean | null
trace_propagation
boolean
not_checked_reason
One of:

Set while the monitor is active but not being checked: quota when the account’s quota for it is used up. Omitted otherwise.

string
Allowed values: quota
Example 
{
  "browser_check": {
    "state": "active",
    "current_status": "success",
    "group_notifications": [
      {
        "notifications": [
          {
            "type": "email",
            "details": {
              "pagerduty_severity": "critical"
            }
          }
        ]
      }
    ],
    "not_checked_reason": "quota"
  }
}

Headers

Section titled “Headers ”
Idempotent-Replayed
string

true when this is the stored first response

400

Section titled “400 ”

Invalid request body, or the page already shows 100 components

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

404

Section titled “404 ”

No such page or monitor in this account

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