[Go to site: main page, start]

Skip to main content
GET
JavaScript
0 Credits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.

Query Parameters

q
string

Free-text search term, matched against the fields named in search_by.

Maximum string length: 200
Example:

"pricing"

search_by
enum<string>[] | null

Comma-separated fields to search with q. Defaults to all of them. Note instructions only exists on extract monitors.

Available options:
name,
url,
instructions,
tags
Example:

"name,url"

search_type
enum<string>

prefix for as-you-type prefix matching (default), exact for full-token matching.

Available options:
exact,
prefix
status
enum<string>

Filter monitors by lifecycle status.

Available options:
active,
paused,
failed
target_type
enum<string>

Filter by target type.

Available options:
page,
sitemap,
extract
change_detection_type
enum<string>

Filter by change detection type.

Available options:
exact,
semantic
tags
string[] | null

Comma-separated list of tags to filter by (matches monitors having any of them).

Maximum array length: 20
Required string length: 1 - 50
Example:

"pricing,competitor"

tag
string

Filter to items that have this tag.

Example:

"pricing"

limit
integer

Maximum number of items to return per page (1-100). Defaults to 25.

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor from a previous response.

Response

A paginated list of monitors

data
Monitor · object[]
required
has_more
boolean
required
next_cursor
string | null
required