Monitors

List monitors

Returns every monitor belonging to the active project. The response is paginated.

GET /api/v1/monitors

Results are paginated, with a default page size of 25.

Query parameters

Name Type Required Description
page integer Optional

The page number to return. Defaults to 1.

per_page integer Optional

The number of items per page. Defaults to 25, maximum 100.

sort_by string Optional

The column to sort by. Defaults to created_at.

sort_order string Optional

The direction to sort by. Each endpoint has its own default.

include string Optional

A comma-separated list of related resources to include in the response. Allowed values: project, project.organization.

Response

Response schema

Field Type Description
data Monitor[]
links PaginationLinks
meta PaginationMeta

The monitor object

Field Type Description
id integer

The unique ID of the monitor.

project_id integer

The ID of the project this monitor runs under.

name string

The display name of the monitor.

models string[]

The AI engines the monitor runs against.

country string

The ISO 3166-1 alpha-2 country code.

language string

The language the monitor runs in.

is_active boolean

Whether the monitor will run on its next daily run.

created_at datetime

When the monitor was created.

updated_at datetime

When the monitor was last updated.