Insights

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

Endpoints

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

List all insights

Required API key scopes

insight:read

Path parameters

  • project_id
    string

Query parameters

  • basic
    boolean
  • created_by
    integer
  • format
    string
    One of: "csv""json"
  • limit
    integer
  • offset
    integer
  • refresh
    string
    Default: force_cache
    One of: "async""async_except_on_cache_miss""blocking""force_async""force_blocking""force_cache""lazy_async"
  • short_id
    string

Response


Example request

GET /api/projects/:project_id/insights
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/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "short_id": "string",
      "name": "string",
      "derived_name": "string",
      "query": {
        "kind": "InsightVizNode",
        "source": {
          "kind": "TrendsQuery",
          "series": [
            {
              "kind": "EventsNode",
              "math": "total",
              "name": "$pageview",
              "event": "$pageview",
              "version": 1
            }
          ],
          "version": 1
        },
        "version": 1
      },
      "order": -2147483648,
      "deleted": true,
      "dashboards": [
        0
      ],
      "dashboard_tiles": [
        {
          "id": 0,
          "dashboard_id": 0,
          "deleted": true
        }
      ],
      "last_refresh": "string",
      "cache_target_age": "string",
      "next_allowed_client_refresh": "string",
      "result": "string",
      "hasMore": "string",
      "columns": "string",
      "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"
      },
      "description": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "tags": [
        null
      ],
      "favorited": true,
      "last_modified_at": "2019-08-24T14:15:22Z",
      "last_modified_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"
      },
      "is_sample": true,
      "effective_restriction_level": 21,
      "effective_privilege_level": 21,
      "user_access_level": "string",
      "timezone": "string",
      "is_cached": "string",
      "query_status": "string",
      "hogql": "string",
      "types": "string",
      "resolved_date_range": "string",
      "_create_in_folder": "string",
      "alerts": "string",
      "last_viewed_at": "string"
    }
  ]
}

Create insights

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
    object
  • order
    integer
  • deleted
    boolean
  • dashboards
    array
  • description
    string
  • tags
    array
  • favorited
    boolean
  • _create_in_folder
    string

Response


Example request

POST /api/projects/:project_id/insights
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/\
	-d name="string"

Example response

Status 201
RESPONSE
{
  "id": 0,
  "short_id": "string",
  "name": "string",
  "derived_name": "string",
  "query": {
    "kind": "InsightVizNode",
    "source": {
      "kind": "TrendsQuery",
      "series": [
        {
          "kind": "EventsNode",
          "math": "total",
          "name": "$pageview",
          "event": "$pageview",
          "version": 1
        }
      ],
      "version": 1
    },
    "version": 1
  },
  "order": -2147483648,
  "deleted": true,
  "dashboards": [
    0
  ],
  "dashboard_tiles": [
    {
      "id": 0,
      "dashboard_id": 0,
      "deleted": true
    }
  ],
  "last_refresh": "string",
  "cache_target_age": "string",
  "next_allowed_client_refresh": "string",
  "result": "string",
  "hasMore": "string",
  "columns": "string",
  "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"
  },
  "description": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "favorited": true,
  "last_modified_at": "2019-08-24T14:15:22Z",
  "last_modified_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"
  },
  "is_sample": true,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "timezone": "string",
  "is_cached": "string",
  "query_status": "string",
  "hogql": "string",
  "types": "string",
  "resolved_date_range": "string",
  "_create_in_folder": "string",
  "alerts": "string",
  "last_viewed_at": "string"
}

List all insights sharing

Required API key scopes

sharing_configuration:read

Path parameters

  • insight_id
    integer
  • project_id
    string

Example request

GET /api/projects/:project_id/insights/:insight_id/sharing
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/:insight_id/sharing/

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Create insights sharing passwords

Create a new password for the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • insight_id
    integer
  • project_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/insights/:insight_id/sharing/passwords
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/:insight_id/sharing/passwords/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Delete insights sharing passwords

Delete a password from the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • insight_id
    integer
  • password_id
    string
  • project_id
    string

Example request

DELETE /api/projects/:project_id/insights/:insight_id/sharing/passwords/:password_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/insights/:insight_id/sharing/passwords/:password_id/

Example response

Status 204 No response body

Create insights sharing refresh

Required API key scopes

sharing_configuration:write

Path parameters

  • insight_id
    integer
  • project_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/insights/:insight_id/sharing/refresh
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/:insight_id/sharing/refresh/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Retrieve insights

Required API key scopes

insight:read

Path parameters

  • id
    integer
  • project_id
    string

Query parameters

  • format
    string
    One of: "csv""json"
  • from_dashboard
    integer
  • refresh
    string
    Default: force_cache
    One of: "async""async_except_on_cache_miss""blocking""force_async""force_blocking""force_cache""lazy_async"

Response


Example request

GET /api/projects/:project_id/insights/:id
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/:id/

Example response

Status 200
RESPONSE
{
  "id": 0,
  "short_id": "string",
  "name": "string",
  "derived_name": "string",
  "query": {
    "kind": "InsightVizNode",
    "source": {
      "kind": "TrendsQuery",
      "series": [
        {
          "kind": "EventsNode",
          "math": "total",
          "name": "$pageview",
          "event": "$pageview",
          "version": 1
        }
      ],
      "version": 1
    },
    "version": 1
  },
  "order": -2147483648,
  "deleted": true,
  "dashboards": [
    0
  ],
  "dashboard_tiles": [
    {
      "id": 0,
      "dashboard_id": 0,
      "deleted": true
    }
  ],
  "last_refresh": "string",
  "cache_target_age": "string",
  "next_allowed_client_refresh": "string",
  "result": "string",
  "hasMore": "string",
  "columns": "string",
  "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"
  },
  "description": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "favorited": true,
  "last_modified_at": "2019-08-24T14:15:22Z",
  "last_modified_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"
  },
  "is_sample": true,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "timezone": "string",
  "is_cached": "string",
  "query_status": "string",
  "hogql": "string",
  "types": "string",
  "resolved_date_range": "string",
  "_create_in_folder": "string",
  "alerts": "string",
  "last_viewed_at": "string"
}

Update insights

Required API key scopes

insight:write

Path parameters

  • id
    integer
  • project_id
    string

Query parameters

  • format
    string
    One of: "csv""json"

Request parameters

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

Response


Example request

PATCH /api/projects/:project_id/insights/: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/insights/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "short_id": "string",
  "name": "string",
  "derived_name": "string",
  "query": {
    "kind": "InsightVizNode",
    "source": {
      "kind": "TrendsQuery",
      "series": [
        {
          "kind": "EventsNode",
          "math": "total",
          "name": "$pageview",
          "event": "$pageview",
          "version": 1
        }
      ],
      "version": 1
    },
    "version": 1
  },
  "order": -2147483648,
  "deleted": true,
  "dashboards": [
    0
  ],
  "dashboard_tiles": [
    {
      "id": 0,
      "dashboard_id": 0,
      "deleted": true
    }
  ],
  "last_refresh": "string",
  "cache_target_age": "string",
  "next_allowed_client_refresh": "string",
  "result": "string",
  "hasMore": "string",
  "columns": "string",
  "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"
  },
  "description": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "tags": [
    null
  ],
  "favorited": true,
  "last_modified_at": "2019-08-24T14:15:22Z",
  "last_modified_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"
  },
  "is_sample": true,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "timezone": "string",
  "is_cached": "string",
  "query_status": "string",
  "hogql": "string",
  "types": "string",
  "resolved_date_range": "string",
  "_create_in_folder": "string",
  "alerts": "string",
  "last_viewed_at": "string"
}

Delete insights

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

insight:write

Path parameters

  • id
    integer
  • project_id
    string

Query parameters

  • format
    string
    One of: "csv""json"

Example request

DELETE /api/projects/:project_id/insights/: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/insights/:id/

Example response

Status 405 No response body

Retrieve insights activity retrieve

Required API key scopes

activity_log:read

Path parameters

  • id
    integer
  • project_id
    string

Query parameters

  • format
    string
    One of: "csv""json"

Example request

GET /api/projects/:project_id/insights/:id/activity
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/:id/activity/

Example response

Status 200 No response body

Retrieve insights activity

Required API key scopes

activity_log:read

Path parameters

  • project_id
    string

Query parameters

  • format
    string
    One of: "csv""json"

Example request

GET /api/projects/:project_id/insights/activity
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/activity/

Example response

Status 200 No response body

Create insights cancel

Path parameters

  • project_id
    string

Query parameters

  • format
    string
    One of: "csv""json"

Request parameters

  • name
    string
  • derived_name
    string
  • query
    object
  • order
    integer
  • deleted
    boolean
  • dashboards
    array
  • description
    string
  • 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"

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/

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
    object
  • 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"

Example response

Status 200 No response body

Community questions

Questions about this page? or post a community question.