Alerts

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET
POST
GET
PATCH
DELETE

List all alerts list

Required API key scopes

alert:read

Path parameters

  • project_id
    string

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/projects/:project_id/alerts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/alerts/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "insight": 0,
      "name": "string",
      "subscribed_users": [
        0
      ],
      "threshold": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created_at": "2019-08-24T14:15:22Z",
        "name": "string",
        "configuration": {
          "bounds": {
            "lower": null,
            "upper": null
          },
          "type": "absolute"
        }
      },
      "condition": {
        "type": "absolute_value"
      },
      "state": "Firing",
      "enabled": true,
      "last_notified_at": "2019-08-24T14:15:22Z",
      "last_checked_at": "2019-08-24T14:15:22Z",
      "next_check_at": "2019-08-24T14:15:22Z",
      "checks": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "created_at": "2019-08-24T14:15:22Z",
          "calculated_value": 0.1,
          "state": "Firing",
          "targets_notified": true
        }
      ],
      "config": {
        "check_ongoing_interval": null,
        "series_index": 0,
        "type": "TrendsAlertConfig"
      },
      "calculation_interval": "hourly",
      "snoozed_until": "2019-08-24T14:15:22Z",
      "skip_weekend": true
    }
  ]
}

Create alerts create

Required API key scopes

alert:write

Path parameters

  • project_id
    string

Request parameters

  • insight
    integer
  • name
    string
  • subscribed_users
    array
  • threshold
  • condition
  • enabled
    boolean
  • config
  • calculation_interval
  • snoozed_until
    string
  • skip_weekend
    boolean

Response


Example request

POST /api/projects/:project_id/alerts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/alerts/\
	-d insight="integer",\
	-d subscribed_users="array",\
	-d threshold=undefined

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "insight": 0,
  "name": "string",
  "subscribed_users": [
    0
  ],
  "threshold": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "name": "string",
    "configuration": {
      "bounds": {
        "lower": null,
        "upper": null
      },
      "type": "absolute"
    }
  },
  "condition": {
    "type": "absolute_value"
  },
  "state": "Firing",
  "enabled": true,
  "last_notified_at": "2019-08-24T14:15:22Z",
  "last_checked_at": "2019-08-24T14:15:22Z",
  "next_check_at": "2019-08-24T14:15:22Z",
  "checks": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2019-08-24T14:15:22Z",
      "calculated_value": 0.1,
      "state": "Firing",
      "targets_notified": true
    }
  ],
  "config": {
    "check_ongoing_interval": null,
    "series_index": 0,
    "type": "TrendsAlertConfig"
  },
  "calculation_interval": "hourly",
  "snoozed_until": "2019-08-24T14:15:22Z",
  "skip_weekend": true
}

Retrieve alerts retrieve

Required API key scopes

alert:read

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

GET /api/projects/:project_id/alerts/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/alerts/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "insight": 0,
  "name": "string",
  "subscribed_users": [
    0
  ],
  "threshold": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "name": "string",
    "configuration": {
      "bounds": {
        "lower": null,
        "upper": null
      },
      "type": "absolute"
    }
  },
  "condition": {
    "type": "absolute_value"
  },
  "state": "Firing",
  "enabled": true,
  "last_notified_at": "2019-08-24T14:15:22Z",
  "last_checked_at": "2019-08-24T14:15:22Z",
  "next_check_at": "2019-08-24T14:15:22Z",
  "checks": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2019-08-24T14:15:22Z",
      "calculated_value": 0.1,
      "state": "Firing",
      "targets_notified": true
    }
  ],
  "config": {
    "check_ongoing_interval": null,
    "series_index": 0,
    "type": "TrendsAlertConfig"
  },
  "calculation_interval": "hourly",
  "snoozed_until": "2019-08-24T14:15:22Z",
  "skip_weekend": true
}

Update alerts update

Required API key scopes

alert:write

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • insight
    integer
  • name
    string
  • subscribed_users
    array
  • threshold
  • condition
  • enabled
    boolean
  • config
  • calculation_interval
  • snoozed_until
    string
  • skip_weekend
    boolean

Response


Example request

PATCH /api/projects/:project_id/alerts/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/alerts/:id/\
	-d created_by=undefined

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "insight": 0,
  "name": "string",
  "subscribed_users": [
    0
  ],
  "threshold": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "name": "string",
    "configuration": {
      "bounds": {
        "lower": null,
        "upper": null
      },
      "type": "absolute"
    }
  },
  "condition": {
    "type": "absolute_value"
  },
  "state": "Firing",
  "enabled": true,
  "last_notified_at": "2019-08-24T14:15:22Z",
  "last_checked_at": "2019-08-24T14:15:22Z",
  "next_check_at": "2019-08-24T14:15:22Z",
  "checks": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2019-08-24T14:15:22Z",
      "calculated_value": 0.1,
      "state": "Firing",
      "targets_notified": true
    }
  ],
  "config": {
    "check_ongoing_interval": null,
    "series_index": 0,
    "type": "TrendsAlertConfig"
  },
  "calculation_interval": "hourly",
  "snoozed_until": "2019-08-24T14:15:22Z",
  "skip_weekend": true
}

Delete alerts destroy

Required API key scopes

alert:write

Path parameters

  • id
    string
  • project_id
    string

Example request

DELETE /api/projects/:project_id/alerts/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/alerts/:id/

Example response

Status 204 No response body

Community questions

Questions about this page? or post a community question.