Insights-3 API Reference

Create insights generate name

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

Required API key scopes

insight:write

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

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

Example request

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

Path parameters

project_id
string

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

Update insight view timestamps. Expects: {"insight_ids": [1, 2, 3, ...]}

Required API key scopes

insight:read

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

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

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 name="string"
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={
		"name": "string"
	}
).json()

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

Insights-3

Endpoints

Create insights generate name

Required API key scopes

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve insights my last viewed

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Create insights viewed

Required API key scopes

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Community questions

Insights-3

Endpoints

Create insights generate name

Required API key scopes

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve insights my last viewed

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Retrieve insights trending

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Create insights viewed

Required API key scopes

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Community questions