How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PostHog alerts API

The alerts API from PostHog — 6 operation(s) for alerts.

PostHog alerts API is one of 139 APIs that PostHog publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 14 operations across 6 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.posthog.com/api.

14 operations 6 paths 42 schemas 2 DELETE4 GET2 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.posthog.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PostHog alerts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 14

Across 6 paths, the API surfaces 14 operations — 2 DELETE, 4 GET, 2 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

alerts 14
GET
/api/environments/{environment_id}/alerts/deprecated
environments_alerts_list 3 params → 200
POST
/api/environments/{environment_id}/alerts/deprecated
environments_alerts_create 1 param body → 201
GET
/api/environments/{environment_id}/alerts/{id}/deprecated
environments_alerts_retrieve 6 params → 200
PUT
/api/environments/{environment_id}/alerts/{id}/deprecated
environments_alerts_update 2 params body → 200
PATCH
/api/environments/{environment_id}/alerts/{id}/deprecated
environments_alerts_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/alerts/{id}/deprecated
environments_alerts_destroy 2 params → 204
POST
/api/environments/{environment_id}/alerts/simulate/deprecated
Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created.
environments_alerts_simulate_create 1 param body → 200
GET
/api/projects/{project_id}/alerts/
alerts_list 3 params → 200
POST
/api/projects/{project_id}/alerts/
alerts_create 1 param body → 201
GET
/api/projects/{project_id}/alerts/{id}/
alerts_retrieve 6 params → 200
PUT
/api/projects/{project_id}/alerts/{id}/
alerts_update 2 params body → 200
PATCH
/api/projects/{project_id}/alerts/{id}/
alerts_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/alerts/{id}/
alerts_destroy 2 params → 204
POST
/api/projects/{project_id}/alerts/simulate/
Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created.
alerts_simulate_create 1 param body → 200

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are PatchedAlert (25 properties), Alert (25 properties), AlertCheck (16 properties), AlertSimulateResponse (10 properties). Each schema is shown below with its type and property counts.

PCADetectorConfig
object
4 properties
ZScoreDetectorConfig
object
4 properties
CalculationIntervalEnum
string
hourly - hourly daily - daily weekly - weekly monthly - monthly
NullEnum
PreprocessingConfig
object
3 properties
AlertCheck
object
16 properties 16 required
EnsembleDetectorConfig
object
3 properties 2 required
COPODDetectorConfig
object
4 properties
AlertScheduleRestriction
object
1 property 1 required
OCSVMDetectorConfig
object
6 properties
AlertConditionType
string
AlertSimulate
object
4 properties 2 required
AlertScheduleRestrictionWindow
object
2 properties 2 required
InvestigationStatusEnum
string
pending - pending running - running done - done failed - failed skipped - skipped
Threshold
object
4 properties 3 required
Alert
object
25 properties 13 required
LOFDetectorConfig
object
5 properties
InsightThreshold
object
2 properties 1 required
HBOSDetectorConfig
object
5 properties
IQRDetectorConfig
object
4 properties
IsolationForestDetectorConfig
object
5 properties
EnsembleOperator
string
InsightThresholdType
string
Method
string
BreakdownSimulationResult
object
9 properties 8 required
AlertCondition
object
1 property 1 required
InsightsThresholdBounds
object
2 properties
UserBasic
object
9 properties 4 required
InvestigationInconclusiveActionEnum
string
notify - Notify suppress - Suppress
BlankEnum
PaginatedAlertList
object
4 properties 2 required
PatchedAlert
object
25 properties
RoleAtOrganizationEnum
string
engineering - Engineering data - Data product - Product Management founder - Founder leadership - Leadership marketing - Marketing sales - Sales / Success othe…
ThresholdDetectorConfig
object
4 properties
ECODDetectorConfig
object
4 properties
AlertSimulateResponse
object
10 properties 8 required
InvestigationVerdictEnum
string
truepositive - truepositive falsepositive - falsepositive inconclusive - inconclusive
TrendsAlertConfig
object
3 properties 1 required
DetectorConfig
Detector configuration types
AlertCheckStateEnum
string
Firing - Firing Not firing - Not firing Errored - Errored Snoozed - Snoozed
KNNDetectorConfig
object
6 properties
MADDetectorConfig
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-alerts-api-openapi.yml Raw ↑

Other APIs PostHog publishes across the network.

PostHog Capture API
PostHog Query API
PostHog Persons API
PostHog Feature Flags API
PostHog Experiments API
PostHog Insights API
PostHog Cohorts API
PostHog Annotations API
PostHog actions API
PostHog activity_log API
PostHog activity_logs API
PostHog advanced_activity_logs API
Where this information came from

This is an independent, third-party profile of PostHog alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.