heartbeat

Get all heartbeat checks

Returns a list of heartbeat checks for an account.

get/heartbeat

Query parameters

status'down' | 'up'

Heartbeat check status

pageinteger

Page of results

limitinteger

The number of heartbeat checks to return per page

tagsstring

Comma separated list of tags assocaited with a check

matchanyboolean

Include heartbeat checks in response that match any specified tag or all tags. This parameter does not take a value. The absence of this paratemer equates to false whilst the presence of thie paramerter equates to true.

nouptimeboolean

Do not calculate uptime percentages for results. This parameter does not take a value. The absence of this paratemer equates to false whilst the presence of thie paramerter equates to true.

Response

Example response

{
  "data": [
    {
      "id": "123",
      "name": "example Heartbeat check",
      "url": "https://push.statuscake.com/?PK=61e7ca9c88f06d0&TestID=123&time=0",
      "period": 1800,
      "contact_groups": [
        "1",
        "2",
        "3"
      ],
      "paused": false,
      "status": "up",
      "tags": [
        "tag1",
        "tag2"
      ],
      "uptime": 99.9
    }
  ],
  "metadata": {
    "page": 1,
    "per_page": 25,
    "page_count": 10,
    "total_count": 230
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.