List Policies

curl https://api.vapi.ai/monitoring/policy \
     -H "Authorization: Bearer <token>"

[
  {
    "name": "High Error Rate Policy",
    "threshold": {
      "type": "percentage",
      "comparator": "gt",
      "value": 50
    },
    "lookbackWindowMinutes": 60,
    "severity": "error",
    "id": "string",
    "orgId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "monitorIds": [
      "string"
    ],
    "schedule": {
      "second": 0,
      "minute": 30,
      "hour": 0,
      "dayOfMonth": [
        1,
        15
      ],
      "month": [
        "JANUARY",
        "APRIL",
        "JULY"
      ],
      "dayOfWeek": [
        "MONDAY",
        "WEDNESDAY",
        "FRIDAY"
      ],
      "year": 2025
    },
    "lastRunAt": "2024-01-15T09:30:00Z"
  }
]

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Query parameters

idstringOptional

This will return policies with the specified id.

severityenumOptional

This will return policies with the specified severity.

Allowed values:

monitorIdstringOptional

This will return policies associated with the specified monitor ID.

pagedoubleOptional>=1

This is the page number to return. Defaults to 1.

sortOrderenumOptional

This is the sort order for pagination. Defaults to 'DESC'.

Allowed values:

limitdoubleOptional0-1000

This is the maximum number of items to return. Defaults to 100.

createdAtGtdatetimeOptional

This will return items where the createdAt is greater than the specified value.

createdAtLtdatetimeOptional

This will return items where the createdAt is less than the specified value.

createdAtGedatetimeOptional

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLedatetimeOptional

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtdatetimeOptional

This will return items where the updatedAt is greater than the specified value.

updatedAtLtdatetimeOptional

This will return items where the updatedAt is less than the specified value.

updatedAtGedatetimeOptional

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLedatetimeOptional

This will return items where the updatedAt is less than or equal to the specified value.

Response

namestring<=100 characters

This is the name of the policy.

thresholdobject

This is the threshold configuration for the policy.

lookbackWindowMinutesdouble1-1440

This is the lookback window in minutes. The policy will query events from the last N minutes.

severityenum

This is the severity level of issues created by this policy.

Allowed values:

idstring

This is the unique identifier for the policy.

orgIdstring

This is the unique identifier for the org that this policy belongs to.

createdAtdatetime

This is the ISO 8601 date-time string of when the policy was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the policy was last updated.

monitorIdslist of strings or null

These are the monitor IDs associated with this policy. This is only present when retrieving a single policy by ID.

scheduleobject or null

This is the schedule configuration for when the policy should run.

lastRunAtdatetime or null

This is the ISO 8601 date-time string of when the policy was last run.