Insight

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

Endpoints

GET
POST
GET
PATCH
DELETE
GET
POST
GET
PATCH
DELETE

List all environments insight variables

Required API key scopes

insight_variable:read

Path parameters

  • environment_id
    string

Query parameters

  • page
    integer

Response


Example request

GET /api/environments/:environment_id/insight_variables
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:environment_id/insight_variables/

Example response

Status 200
RESPONSE
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "String",
"default_value": null,
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"code_name": "string",
"values": null
}
]
}

Create environments insight variables

Required API key scopes

insight_variable:write

Path parameters

  • environment_id
    string

Request parameters

  • name
    string
  • type
  • default_value
  • values

Response


Example request

POST /api/environments/:environment_id/insight_variables
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/environments/:environment_id/insight_variables/\
-d name="string",\
-d type=undefined

Example response

Status 201
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "String",
"default_value": null,
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"code_name": "string",
"values": null
}

Retrieve environments insight variables

Required API key scopes

insight_variable:read

Path parameters

  • environment_id
    string
  • id
    string

Response


Example request

GET /api/environments/:environment_id/insight_variables/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:environment_id/insight_variables/:id/

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "String",
"default_value": null,
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"code_name": "string",
"values": null
}

Update environments insight variables

Required API key scopes

insight_variable:write

Path parameters

  • environment_id
    string
  • id
    string

Request parameters

  • name
    string
  • type
  • default_value
  • values

Response


Example request

PATCH /api/environments/:environment_id/insight_variables/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:environment_id/insight_variables/:id/\
-d name="string"

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "String",
"default_value": null,
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"code_name": "string",
"values": null
}

Delete environments insight variables

Required API key scopes

insight_variable:write

Path parameters

  • environment_id
    string
  • id
    string

Example request

DELETE /api/environments/:environment_id/insight_variables/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X DELETE \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/environments/:environment_id/insight_variables/:id/

Example response

Status 204 No response body

List all insight variables

Required API key scopes

insight_variable:read

Path parameters

  • project_id
    string

Query parameters

  • page
    integer

Response


Example request

GET /api/projects/:project_id/insight_variables
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/insight_variables/

Example response

Status 200
RESPONSE
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "String",
"default_value": null,
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"code_name": "string",
"values": null
}
]
}

Create insight variables

Required API key scopes

insight_variable:write

Path parameters

  • project_id
    string

Request parameters

  • name
    string
  • type
  • default_value
  • values

Response


Example request

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

Example response

Status 201
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "String",
"default_value": null,
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"code_name": "string",
"values": null
}

Retrieve insight variables

Required API key scopes

insight_variable:read

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "String",
"default_value": null,
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"code_name": "string",
"values": null
}

Update insight variables

Required API key scopes

insight_variable:write

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • name
    string
  • type
  • default_value
  • values

Response


Example request

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

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "String",
"default_value": null,
"created_by": 0,
"created_at": "2019-08-24T14:15:22Z",
"code_name": "string",
"values": null
}

Delete insight variables

Required API key scopes

insight_variable:write

Path parameters

  • id
    string
  • project_id
    string

Example request

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

Example response

Status 204 No response body

Community questions

Questions about this page? or post a community question.