Logs-2
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
POST | |
POST | |
POST | |
GET | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
GET |
Create environments logs sampling rules
Required API key scopes
logs:writeRequest parameters
- namestring
- enabledbooleanDefault:
false - priorityintegernull
- rule_type
- scope_servicestringnull
- scope_path_patternstringnull
- scope_attribute_filtersarray
- config
Response
Example request
POST /api /environments /:environment_id /logs /sampling_rulesExample response
Status 201
RESPONSE
Retrieve environments logs sampling rules
Required API key scopes
logs:readPath parameters
- idstring
Response
Example request
GET /api /environments /:environment_id /logs /sampling_rules /:idExample response
Status 200
RESPONSE
Update environments logs sampling rules
Required API key scopes
logs:writePath parameters
- idstring
Request parameters
- namestring
- enabledbooleanDefault:
false - priorityintegernull
- rule_type
- scope_servicestringnull
- scope_path_patternstringnull
- scope_attribute_filtersarray
- config
Response
Example request
PATCH /api /environments /:environment_id /logs /sampling_rules /:idExample response
Status 200
RESPONSE
Delete environments logs sampling rules
Required API key scopes
logs:writePath parameters
- idstring
Example request
DELETE /api /environments /:environment_id /logs /sampling_rules /:idExample response
Status 204 No response body
Create environments logs sampling rules simulate
Dry-run estimate for how much volume this rule would remove (placeholder response until CH-backed simulation is wired).
Path parameters
- idstring
Response
Example request
POST /api /environments /:environment_id /logs /sampling_rules /:id /simulateExample response
Status 200
RESPONSE
Create environments logs sampling rules reorder
Atomically reassign priorities so the given ID order maps to ascending priorities (0..n-1).
Query parameters
- limitinteger
- offsetinteger
Request parameters
- ordered_idsarray
Response
Example request
POST /api /environments /:environment_id /logs /sampling_rules /reorderExample response
Status 200
RESPONSE
Create environments logs services
Also available via the PostHog MCP server:
logs-services-create— List services with stats
Required API key scopes
logs:readRequest parameters
- query
Response
Example request
POST /api /environments /:environment_id /logs /servicesExample response
Status 200
RESPONSE
Create environments logs sparkline
Required API key scopes
logs:readRequest parameters
- query
Response
Example request
POST /api /environments /:environment_id /logs /sparklineExample response
Status 200
RESPONSE
Retrieve environments logs values
Required API key scopes
logs:readQuery parameters
- attribute_typestringOne of:
"log""resource" - dateRange
- filterGrouparrayDefault:
- keystring
- serviceNamesarrayDefault:
- valuestring
Response
Example request
GET /api /environments /:environment_id /logs /valuesExample response
Status 200
RESPONSE
List all environments logs views
Required API key scopes
logs:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:environment_id /logs /viewsExample response
Status 200
RESPONSE
Create environments logs views
Required API key scopes
logs:writeRequest parameters
- namestring
- filtersobject
- pinnedboolean
Response
Example request
POST /api /environments /:environment_id /logs /viewsExample response
Status 201
RESPONSE
Retrieve environments logs views
Required API key scopes
logs:readPath parameters
- short_idstring
Response
Example request
GET /api /environments /:environment_id /logs /views /:short_idExample response
Status 200
RESPONSE
Update environments logs views
Required API key scopes
logs:writePath parameters
- short_idstring
Request parameters
- namestring
- filtersobject
- pinnedboolean
Response
Example request
PATCH /api /environments /:environment_id /logs /views /:short_idExample response
Status 200
RESPONSE
Delete environments logs views
Required API key scopes
logs:writePath parameters
- short_idstring
Example request
DELETE /api /environments /:environment_id /logs /views /:short_idExample response
Status 204 No response body
List all logs alerts
Also available via the PostHog MCP server:
logs-alerts-list— List log alerts
Required API key scopes
logs:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /logs /alertsExample response
Status 200
RESPONSE
Create logs alerts
Also available via the PostHog MCP server:
logs-alerts-create— Create log alert
Required API key scopes
logs:writeRequest parameters
- namestring
- enabledbooleanDefault:
true - filters
- threshold_countintegerDefault:
100 - threshold_operatorDefault:
above - window_minutesintegerDefault:
5 - evaluation_periodsintegerDefault:
1 - datapoints_to_alarmintegerDefault:
1 - cooldown_minutesintegerDefault:
0 - snooze_untilstringnull
Response
Example request
POST /api /projects /:project_id /logs /alertsExample response
Status 201
RESPONSE
Retrieve logs alerts
Also available via the PostHog MCP server:
logs-alerts-retrieve— Get log alert
Required API key scopes
logs:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /logs /alerts /:idExample response
Status 200
RESPONSE