Insights-3 API Reference

Create insights bulk update tags

Bulk update tags on multiple objects.

PAT access: this action has no required_scopes= on the decorator — inheriting viewsets must add "bulk_update_tags" to their scope_object_write_actions list to accept personal API keys. Without that opt-in, APIScopePermission rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting <scope>:write for one resource doesn't leak access to sibling resources that share this mixin.

Accepts:

{"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]}

Actions:

"add": Add tags to existing tags on each object
"remove": Remove specific tags from each object
"set": Replace all tags on each object with the provided list

Query parameters

format
string
One of: "csv""json"

Request parameters

ids
array
action
tags
array

Response

Example request

POST /api/projects/:project_id/insights/bulk_update_tags
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/insights/bulk_update_tags/\
	-d ids="array",\
	-d action=undefined,\
	-d tags="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/insights/bulk_update_tags/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"ids": "array",
		"tags": "array"
	}
).json()

Example response

Status 200

RESPONSE
{
  "updated": [
    {
      "id": 0,
      "tags": [
        "string"
      ]
    }
  ],
  "skipped": [
    {
      "id": 0,
      "reason": "string"
    }
  ]
}

Create insights cancel

DRF ViewSet mixin that gates coalesced responses behind permission checks.

The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF's initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.

Query parameters

format
string
One of: "csv""json"

Request parameters

name
stringnull
derived_name
stringnull
query
order
integernull
deleted
boolean
dashboards
array
description
stringnull
tags
array
favorited
boolean
_create_in_folder
string

Example request

POST /api/projects/:project_id/insights/cancel
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/insights/cancel/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/insights/cancel/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200 No response body

Create insights generate metadata

Generate an AI-suggested name and description for an insight based on its query configuration.

Required API key scopes

insight:write

Query parameters

format
string
One of: "csv""json"

Request parameters

name
stringnull
derived_name
stringnull
query
order
integernull
deleted
boolean
dashboards
array
description
stringnull
tags
array
favorited
boolean
_create_in_folder
string

Example request

POST /api/projects/:project_id/insights/generate_metadata
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/insights/generate_metadata/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/insights/generate_metadata/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200 No response body

Retrieve insights my last viewed

Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Create insights viewed

Record that the current user has just viewed one or more insights. Submitted ids that do not belong to the current project or that point at deleted insights are silently dropped. Returns 201 on success regardless of how many ids were retained.

Required API key scopes

insight:read

Query parameters

format
string
One of: "csv""json"

Request parameters

insight_ids
array

Example request

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

Example response

Status 201 Views recorded.

← Previous page

`POST`
`POST`
`POST`
`GET`
`GET`
`POST`

Insights-3

Endpoints

Create insights bulk update tags

Query parameters

Request parameters

Response

Example request

Example response

Status 200

Create insights cancel

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Create insights generate metadata

Required API key scopes

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve insights my last viewed

Query parameters

Example request

Example response

Status 200 No response body

Create insights viewed

Required API key scopes

Query parameters

Request parameters

Example request

Example response

Status 201 Views recorded.

Community questions

Insights-3

Endpoints

Create insights bulk update tags

Query parameters

Request parameters

Response

Example request

Example response

Status 200

Create insights cancel

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Create insights generate metadata

Required API key scopes

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve insights my last viewed

Query parameters

Example request

Example response

Status 200 No response body

Retrieve insights trending

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create insights viewed

Required API key scopes

Query parameters

Request parameters

Example request

Example response

Status 201 Views recorded.

Community questions