List Heartbeats

List heartbeats for the active organization, optionally filtered by a search query and by tags: with tag_match=all (default) a heartbeat must carry every tag given, with tag_match=any at least one. Ordered by the given sort option (problems-first by default).

get/v1/heartbeats

Request

Base URL: https://api.fettle.sh (the document declares no server; this is the origin it was published from)
URL: https://api.fettle.sh/v1/heartbeats
Auth: API key in header Authorization

Query parameters

qstring nullable

sort'status' | 'name' | 'created_at'

Ordering options for the heartbeat listing endpoint.

tagstring[] nullable

tag_match'all' | 'any'

How a multi-tag filter combines: every tag (ALL) or any of them.

pageinteger

sizeinteger

Headers

X-Organization-Idstring uuid nullable

Response

Successful Response

totalinteger required

pageinteger required

sizeinteger required

pagesinteger required

Changes

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