Skip to main content
GET
/
api
/
v1
/
monitors
List Monitors
curl --request GET \
  --url https://app.datafold.com/api/v1/monitors \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "monitors": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "enabled": true,
      "id": 123,
      "modified_at": "2023-11-07T05:31:56Z",
      "monitor_type": "diff",
      "name": "<string>",
      "last_alert": "2023-11-07T05:31:56Z",
      "last_run": "2023-11-07T05:31:56Z",
      "state": "ok",
      "tags": [
        "<string>"
      ]
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

Authorizations

​
Authorization
string
header
required

Use the 'Authorization' header with the format 'Key '

Query Parameters

​
page
integer
default:1

The page number to retrieve.

​
page_size
integer
default:20

The number of items to retrieve per page.

​
order_by
enum<string> | null

Field to order the monitors by.

Available options:
id,
name,
last_triggered,
last_run,
created_by_id
​
sort_order
enum<string>
default:desc

Specify the order direction for the monitors.

Available options:
asc,
desc
​
tags
string

Comma-separated tags to filter monitors by.

Response

Successful Response

​
count
integer
required

Total number of monitors.

​
monitors
ApiPublicGetMonitorOut · object[]
required

List of monitor details.

​
page
integer
required

Current page number in the paginated result.

​
page_size
integer
required

Number of monitors per page.

​
total_pages
integer
required

Total number of pages available.