alerts

get/api/projects/{project_id}/alerts/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/alerts/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

created_bystring uuid

Optional. Restrict results to alerts created by the user with this UUID.

has_detectorboolean

Optional. Restrict results by whether the alert uses anomaly detection.

insight_idinteger

Optional. Restrict results to alerts on this insight ID.

insight_tagstring

Optional. Restrict results to alerts whose insight has this tag.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

searchstring

Optional. Fuzzy match against alert name using Postgres trigram word similarity (handles typos, transpositions, and prefix-as-you-type). Results are ordered by relevance, then creation time. Capped at 200 characters; longer queries return a 400 error.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

No recorded changes to this operation across all 1 revision of this API.