Logs-3 API Reference

Logs-3

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

Endpoints

`PATCH`
`DELETE`
`GET`
`POST`
`GET`
`POST`
`POST`
`GET`

Update logs alerts

Required API key scopes

logs:write

Path parameters

id
string
project_id
string

Request parameters

name
string
enabled
boolean
filters
threshold_count
integer
threshold_operator
Default: above
window_minutes
integer
evaluation_periods
integer
Default: 1
datapoints_to_alarm
integer
Default: 1
cooldown_minutes
integer
snooze_until
string

Response

Example request

PATCH /api/projects/:project_id/logs/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/logs/alerts/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/logs/alerts/{logs-3_id}/".format(
        project_id=project_id,
		logs-3_id="<the logs-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "enabled": true,
  "filters": null,
  "threshold_count": 1,
  "threshold_operator": "above",
  "window_minutes": 2147483647,
  "check_interval_minutes": 0,
  "state": "not_firing",
  "evaluation_periods": 1,
  "datapoints_to_alarm": 1,
  "cooldown_minutes": 2147483647,
  "snooze_until": "2019-08-24T14:15:22Z",
  "next_check_at": "2019-08-24T14:15:22Z",
  "last_notified_at": "2019-08-24T14:15:22Z",
  "last_checked_at": "2019-08-24T14:15:22Z",
  "consecutive_failures": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "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"
  },
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete logs alerts

Required API key scopes

logs:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/projects/:project_id/logs/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/logs/alerts/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/logs/alerts/{logs-3_id}/".format(
        project_id=project_id,
		logs-3_id="<the logs-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Delete logs alerts

Required API key scopes

logs:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/projects/:project_id/logs/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/logs/alerts/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/logs/alerts/{logs-3_id}/".format(
        project_id=project_id,
		logs-3_id="<the logs-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Retrieve logs attributes

Required API key scopes

logs:read

Path parameters

project_id
string

Example request

GET /api/projects/:project_id/logs/attributes
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/logs/attributes/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/logs/attributes/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create logs export

Required API key scopes

logs:read

Path parameters

project_id
string

Example request

POST /api/projects/:project_id/logs/export
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/logs/export/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/logs/export/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve logs has logs

Required API key scopes

logs:read

Path parameters

project_id
string

Example request

GET /api/projects/:project_id/logs/has_logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/logs/has_logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/logs/has_logs/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create logs query

Required API key scopes

logs:read

Path parameters

project_id
string

Example request

POST /api/projects/:project_id/logs/query
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/logs/query/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/logs/query/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create logs sparkline

Required API key scopes

logs:read

Path parameters

project_id
string

Example request

POST /api/projects/:project_id/logs/sparkline
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/logs/sparkline/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/logs/sparkline/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve logs values

Required API key scopes

logs:read

Path parameters

project_id
string

Example request

GET /api/projects/:project_id/logs/values
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/logs/values/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/logs/values/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Logs-3

Endpoints

Update logs alerts

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete logs alerts

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Delete logs alerts

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Retrieve logs attributes

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Create logs export

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve logs has logs

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Create logs query

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Create logs sparkline

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve logs values

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Community questions