Customer API Reference

Customer

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

Endpoints

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

List all customer journeys

Required API key scopes

customer_journey:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

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

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "insight": 0,
      "name": "string",
      "description": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create customer journeys

Required API key scopes

customer_journey:write

Path parameters

project_id
string

Request parameters

insight
integer
name
string
description
string

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "insight": 0,
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve customer journeys

Required API key scopes

customer_journey:read

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "insight": 0,
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Update customer journeys

Required API key scopes

customer_journey:write

Path parameters

id
string
project_id
string

Request parameters

insight
integer
name
string
description
string

Response

Example request

PATCH /api/environments/:project_id/customer_journeys/: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/:project_id/customer_journeys/:id/\
	-d insight="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/customer_journeys/{customer_journey_id}/".format(
        project_id=project_id,
		customer_journey_id="<the customer journey id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"insight": "integer"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "insight": 0,
  "name": "string",
  "description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete customer journeys

Required API key scopes

customer_journey:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/environments/:project_id/customer_journeys/: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/:project_id/customer_journeys/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/customer_journeys/{customer_journey_id}/".format(
        project_id=project_id,
		customer_journey_id="<the customer journey id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Customer

Endpoints

List all customer journeys

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create customer journeys

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve customer journeys

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update customer journeys

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete customer journeys

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions