Prompts

List prompts

Returns every prompt belonging to the active project, optionally filtered to a single monitor. The response is paginated.

GET /api/v1/prompts

Query parameters

Name Type Required Description
monitor_id integer Optional

Limit results to a single monitor.

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: monitor, monitor.project, monitor.project.organization.

Response

Response schema

Field Type Description
data Prompt[]
links PaginationLinks
meta PaginationMeta

The prompt object

Field Type Description
id integer

The unique ID of the prompt.

monitor_id integer

The ID of the monitor that owns this prompt.

prompt string

The question text the monitor asks each engine on every run.

is_active boolean

Whether the prompt will run on each daily run of its monitor.

created_at datetime

When the prompt was created.

updated_at datetime

When the prompt was last updated.