Skip to content
StatusTick

API reference

Checks and metrics

Checks and metrics endpoints of the StatusTick REST API: uptime and response times of all monitors, hourly status bars and uptime of some monitors.

GET/v1/monitors/stats

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Query Parameters

hours?integer
Rangevalue <= 2160
Default24
excludeMaintenance?boolean

Leave out checks during maintenance windows.

Defaultfalse

Response Body

application/json

curl -X GET "https://example.com/v1/monitors/stats"
{
  "from": "2026-09-27T10:00:00Z",
  "to": "2026-09-28T10:00:00Z",
  "totalChecks": 1440,
  "uptimePercentage": 0.9993,
  "averageResponseTimeMs": 212,
  "p95ResponseTimeMs": 480,
  "p99ResponseTimeMs": 910,
  "monitors": [
    {
      "monitorId": "mnt_4KrVK3M1DqhDTFouCffKie",
      "totalChecks": 1440,
      "uptimePercentage": 0.9993,
      "averageResponseTimeMs": 212
    }
  ]
}
GET/v1/monitors/summaries

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Query Parameters

monitorIds*array<string>

Monitors not found are left out.

Itemsitems <= 200
hours?integer
Default24
days?integer

Days that uptime30d covers.

Default30

Response Body

application/json

curl -X GET "https://example.com/v1/monitors/summaries?monitorIds=string"
[
  {
    "monitorId": "mnt_4KrVK3M1DqhDTFouCffKie",
    "hourly": [
      {
        "start": "2026-09-28T09:00:00Z",
        "status": "UP",
        "uptime": 1
      }
    ],
    "uptime30d": 0.9993
  }
]

Count monitors by state

GET/v1/monitors/counts

Active and paused monitors, each in the first state that applies: paused inactive, maintenance in a running maintenance window, down last checked DOWN or ERROR, degraded, blocked, up, and pending not checked yet. They add up to total.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Response Body

application/json

curl -X GET "https://example.com/v1/monitors/counts"
{
  "total": 12,
  "paused": 1,
  "maintenance": 1,
  "down": 1,
  "degraded": 1,
  "blocked": 0,
  "up": 8,
  "pending": 0
}
GET/v1/monitors/daily-stats

The same as a monitor's daily stats, today so far included when asked, for up to 500 monitors at once.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Query Parameters

monitorIds*array<string>

Monitors not found are left out.

from*string
Formatdate
to*string

Included.

Formatdate
includeToday?boolean
Defaultfalse

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/monitors/daily-stats?monitorIds=string&from=2026-01-01&to=2026-09-28"
{
  "mnt_4KrVK3M1DqhDTFouCffKie": {
    "from": "2026-09-27",
    "to": "2026-09-28",
    "uptime": 0.9993,
    "downtimeMinutes": 1,
    "days": [
      {
        "day": "2026-09-27",
        "checks": 1440,
        "uptime": 0.9993,
        "averageMs": 184,
        "p95Ms": 320,
        "downtimeMinutes": 1
      }
    ]
  }
}
POST/v1/monitors/metrics

Up to 100 monitors over one range in one call. Up to 48 hours comes from each check, up to 90 days from hourly totals, longer from daily ones. Only monitor_availability and monitor_response_time_ms have series here.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/monitors/metrics" \
  -H "Content-Type: application/json" \
  -d '{
    "monitorIds": [
      "mnt_4KrVK3M1DqhDTFouCffKie"
    ],
    "metrics": [
      "monitor_response_time_ms"
    ],
    "from": "2026-09-28T09:00:00Z",
    "to": "2026-09-28T10:00:00Z",
    "stepSeconds": 900
  }'
{
  "mnt_4KrVK3M1DqhDTFouCffKie": [
    {
      "metricName": "monitor_response_time_ms",
      "from": "2026-09-28T09:00:00Z",
      "to": "2026-09-28T10:00:00Z",
      "stepSeconds": 900,
      "labels": {},
      "points": [
        {
          "bucketStart": "2026-09-28T09:00:00Z",
          "sum": 2100,
          "count": 10,
          "min": 150,
          "max": 320,
          "average": 210
        }
      ]
    }
  ]
}
GET/v1/monitors/regions

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Query Parameters

monitorIds?array<string>

Only these monitors. Default is all.

Response Body

application/json

curl -X GET "https://example.com/v1/monitors/regions"
[
  {
    "monitorId": "mnt_4KrVK3M1DqhDTFouCffKie",
    "regions": [
      {
        "zone": "us-east",
        "name": "US East",
        "status": "UP",
        "responseTimeMs": 150,
        "checkedAt": "2026-09-28T10:00:01Z"
      }
    ]
  }
]
GET/v1/monitors/{monitorId}/events

The monitor's private locations going offline and coming back, and results an agent checked while offline and reported late (REPORTED_LATE, with the period they cover), newest first.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Query Parameters

limit?integer
Rangevalue <= 100
Default20

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/events"
[
  {
    "type": "LOCATION_OFFLINE",
    "occurredAt": "2026-09-28T09:40:00Z",
    "locationId": "loc_5HbRz8TtYw3nMaK1pQv0Ud",
    "locationName": "Office network",
    "agentHostName": "agent-1",
    "agentSeenAt": "2026-09-28T09:37:00Z"
  }
]
GET/v1/monitors/{monitorId}/checks

Pass nextBefore as before for the next page.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Query Parameters

before?string

Only results before this time; now when left out.

Formatdate-time
limit?integer
Range1 <= value <= 100
Default50
statuses?array<>

Only results with these statuses.

zone?string

Only results with an answer from this zone, showing that answer alone.

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/checks"
{
  "items": [
    {
      "checkedAt": "2026-09-28T10:00:01Z",
      "status": "UP",
      "averageResponseTimeMs": 184,
      "zones": [
        {
          "zone": "us-east",
          "status": "UP",
          "responseTimeMs": 150,
          "statusCode": 200,
          "error": null
        }
      ]
    }
  ],
  "nextBefore": "2026-09-28T09:59:01Z"
}

Run a check now

POST/v1/monitors/{monitorId}/checks

Needs a READ_WRITE key. One per monitor every 10 seconds; the schedule does not change.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/checks"
{
  "completed": true,
  "status": "UP",
  "checkedAt": "2026-09-28T10:00:01Z",
  "averageResponseTimeMs": 184,
  "zones": [
    {
      "zone": "US_EAST",
      "status": "UP",
      "responseTimeMs": 150,
      "statusCode": 200,
      "message": null,
      "rechecked": false,
      "ipVersion": null
    }
  ]
}
GET/v1/monitors/{monitorId}/checks/latest

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Response Body

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/checks/latest"
{
  "checkedAt": "2026-09-28T10:00:01Z",
  "status": "UP",
  "averageResponseTimeMs": 184,
  "zones": [
    {
      "zone": "us-east",
      "status": "UP",
      "responseTimeMs": 150,
      "statusCode": 200,
      "error": null
    }
  ]
}
GET/v1/monitors/{monitorId}/metrics

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Query Parameters

metric*string
from?string

Default is 24 hours ago.

Formatdate-time
to?string

Default is now.

Formatdate-time
stepSeconds?integer
Default300
zone?string

Value in

  • "GLOBAL"
  • "US_WEST"
  • "US_CENTRAL"
  • "US_EAST"
  • "CANADA"
  • "SOUTH_AMERICA_EAST"
  • "SOUTH_AMERICA_WEST"
  • "EUROPE_WEST"
  • "EUROPE_CENTRAL"
  • "EUROPE_NORTH"
  • "EUROPE_SOUTH"
  • "TURKIYE"
  • "MIDDLE_EAST"
  • "AFRICA_SOUTH"
  • "ASIA_PACIFIC_SOUTH"
  • "ASIA_PACIFIC_EAST"
  • "ASIA_PACIFIC_NORTHEAST"
  • "ASIA_PACIFIC_SOUTHEAST"
  • "AUSTRALIA"
status?string
statusClass?string

Response Body

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/metrics?metric=response_time_ms&statusClass=5xx"
{
  "metricName": "response_time_ms",
  "from": "2026-09-28T09:00:00Z",
  "to": "2026-09-28T10:00:00Z",
  "stepSeconds": 300,
  "labels": {},
  "points": [
    {
      "bucketStart": "2026-09-28T09:00:00Z",
      "sum": 2100,
      "count": 10,
      "min": 150,
      "max": 320,
      "average": 210
    }
  ]
}
GET/v1/monitors/{monitorId}/region-stats

Percentiles are within one histogram bucket of exact.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Query Parameters

days?integer
Rangevalue <= 366
Default30

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/region-stats"
[
  {
    "zone": "eu-central",
    "name": "EU Central",
    "checks": 43200,
    "uptime": 0.9995,
    "averageMs": 182,
    "p95Ms": 340,
    "p99Ms": 610,
    "downtimeMinutes": 21.6
  }
]
GET/v1/monitors/{monitorId}/response-time-by-zone

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Query Parameters

hours?integer
Rangevalue <= 8784
Default24

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/response-time-by-zone"
[
  {
    "zone": "string",
    "name": "string",
    "points": [
      {
        "bucketStart": "2019-08-24T14:15:22Z",
        "sum": 0,
        "count": 0,
        "min": 0,
        "max": 0,
        "average": 0
      }
    ]
  }
]

Daily uptime history

GET/v1/monitors/{monitorId}/daily-stats

Days are UTC.

Authorization

apiKey
AuthorizationBearer <token>

Your organization's API key.

In: header

Path Parameters

monitorId*string

Query Parameters

from*string
Formatdate
to*string

Included.

Formatdate

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/monitors/mnt_4KrVK3M1DqhDTFouCffKie/daily-stats?from=2026-01-01&to=2026-09-28"
{
  "from": "2026-09-27",
  "to": "2026-09-28",
  "uptime": 0.9993,
  "downtimeMinutes": 1,
  "days": [
    {
      "day": "2026-09-27",
      "checks": 1440,
      "uptime": 0.9993,
      "averageMs": 184,
      "p95Ms": 320,
      "downtimeMinutes": 1
    }
  ]
}
All docs