List status page resources

GET https://incidents.betterstack.com/api/v2/status-pages/{status_page_id}/resources

URL parameters

status_page_id

required string

The ID of your status page

Query parameters

page

integer

The page number to return, starting with 1.

per_page

integer

Number of results per page. Defaults to 50, maximum 250.

Headers

Authorization

required string

Bearer $TOKEN

200

Returns a list of the resources of your status page.

Response body

{
  "data": [
    {
      "id": "12345",
      "type": "status_page_resource",
      "attributes": {
        "status_page_section_id": 456789,
        "resource_id": 112233,
        "resource_type": "Monitor",
        "history": true,
        "widget_type": "history",
        "public_name": "https://uptime.betterstack.com/",
        "explanation": "",
        "position": 0,
        "mark_as_down_for": "incident_matching_metadata",
        "mark_as_down_metadata_rule": {
          "key": "Escalation policy",
          "values": [
            {
              "type": "Policy",
              "item_id": 13245,
              "name": "Primary Policy"
            }
          ]
        },
        "mark_as_degraded_for": "any_incident",
        "catalog_reference": null,
        "availability": 0.99963,
        "status": "operational",
        "status_history": [
          {
            "day": "2022-01-01",
            "status": "operational",
            "downtime_duration": 0,
            "maintenance_duration": 0
          },
          {
            "day": "2022-01-02",
            "status": "downtime",
            "downtime_duration": 120.0,
            "maintenance_duration": 0
          }
        ]
      }
    },
    {
      "id": "12346",
      "type": "status_page_resource",
      "attributes": {
        "status_page_section_id": 456789,
        "resource_id": 112234,
        "resource_type": "Monitor",
        "history": true,
        "widget_type": "history",
        "public_name": "https://wallmine.com/",
        "explanation": "",
        "position": 1,
        "mark_as_down_for": "any_incident",
        "mark_as_degraded_for": "no_incident",
        "catalog_reference": null,
        "availability": 1.0,
        "status": "operational",
        "status_history": [
          {
            "day": "2022-01-01",
            "status": "operational",
            "downtime_duration": 0,
            "maintenance_duration": 0
          },
          {
            "day": "2022-01-02",
            "status": "operational",
            "downtime_duration": 0,
            "maintenance_duration": 0
          }
        ]
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/status-pages/123456789/resources?page=1",
    "last": "https://incidents.betterstack.com/api/v2/status-pages/123456789/resources?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

string

The ID of the status page resource.

type

string

Always status_page_resource.

attributes.status_page_section_id

integer

The ID of the section this resource sits in.

attributes.resource_id

integer

The ID of the resource this row shows, for example the monitor's ID.

attributes.resource_type

string

The type of the resource: ManuallyTrackedItem, Monitor, MonitorGroup, Heartbeat, HeartbeatGroup, WebhookIntegration, EmailIntegration, IncomingWebhook, AmazonSnsIntegration, LogsChart, CatalogReference, or ThirdPartyService for a third party service added in the status page editor.

attributes.history

boolean

Deprecated, use widget_type. true when widget_type is history.

attributes.widget_type

string

What widget the status page shows for this resource: plain, history, intraday_history, response_times, intraday_response_times, or chart_only.

attributes.public_name

string

The resource name displayed publicly on your status page.

attributes.explanation

string or null

A detailed text displayed as a help icon.

attributes.position

integer

The position of this resource in its section, indexed from zero.

attributes.mark_as_down_for

string

Which incidents mark the resource as down: any_incident, no_incident, or incident_matching_metadata for those matching mark_as_down_metadata_rule.

attributes.mark_as_down_metadata_rule

object

The rule incident metadata has to match to mark the resource as down. Present only when mark_as_down_for is incident_matching_metadata.

attributes.mark_as_down_metadata_rule.key

string

The metadata key to match.

attributes.mark_as_down_metadata_rule.values

array

The values to match. An incident whose metadata has any of them marks the resource down.

attributes.mark_as_down_metadata_rule.values[].type

string

String for a text value, or the type of the catalog item: User, Team, Policy, Schedule, Endpoint, SlackIntegration, LinearIntegration, JiraIntegration, MicrosoftTeamsWebhook, ZapierWebhook, NativeWebhook, PagerDutyWebhook, or Source.

attributes.mark_as_down_metadata_rule.values[].value

string

The text value. Only for type String.

attributes.mark_as_down_metadata_rule.values[].item_id

integer

The ID of the catalog item. For every type except String.

attributes.mark_as_down_metadata_rule.values[].name

string

The catalog item's name, when the item still exists. For every type except String.

attributes.mark_as_down_metadata_rule.values[].email

string

The user's e-mail. Only for type User.

attributes.mark_as_degraded_for

string

Which incidents mark the resource as degraded: any_incident, no_incident, or incident_matching_metadata for those matching mark_as_degraded_metadata_rule.

attributes.mark_as_degraded_metadata_rule

object

The rule incident metadata has to match to mark the resource as degraded, in the same shape as mark_as_down_metadata_rule. Present only when mark_as_degraded_for is incident_matching_metadata.

attributes.catalog_reference

object or null

The catalog value a CatalogReference resource shows, in the shape create and update accept. null for other resource types.

attributes.catalog_reference.key

string

The catalog key, for example Service.

attributes.catalog_reference.value

object

The catalog value, in the same shape as an entry of mark_as_down_metadata_rule.values.

attributes.availability

number

The uptime over the status page's history, as a fraction from 0 to 1.

attributes.status

string

The current status: operational, degraded, downtime, maintenance, or not_monitored when the underlying monitor or heartbeat is paused.

attributes.status_history

array

One entry per bar of the status page's history, oldest first.

attributes.status_history[].day

string

The day the bar starts on, in YYYY-MM-DD format.

attributes.status_history[].status

string

The status during that bar: operational, degraded, downtime, maintenance, or not_monitored. Today's bar reads recovered or recovered_degraded after an incident that ended today.

attributes.status_history[].downtime_duration

number

The downtime during that bar, in seconds.

attributes.status_history[].maintenance_duration

number

The maintenance during that bar, in seconds.

pagination.first

string

The URL of the first page. Read more about pagination.

pagination.last

string

The URL of the last page.

pagination.prev

string or null

The URL of the previous page, or null on the first page.

pagination.next

string or null

The URL of the next page, or null on the last page.

Explore documentation

Example cURL

Explore documentation

List status page resources

Example cURL

Please accept cookies