Signal Source API Reference

Signal Source

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

Endpoints

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

List all signal source configs

Required API key scopes

task:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/signal_source_configs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/signal_source_configs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/signal_source_configs/".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",
      "source_product": "session_replay",
      "source_type": "session_analysis_cluster",
      "enabled": true,
      "config": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "status": "string"
    }
  ]
}

Create signal source configs

Required API key scopes

task:write

Path parameters

project_id
string

Request parameters

source_product
source_type
enabled
boolean
config

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "source_product": "session_replay",
  "source_type": "session_analysis_cluster",
  "enabled": true,
  "config": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "status": "string"
}

Retrieve signal source configs

Required API key scopes

task:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/projects/:project_id/signal_source_configs/: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/signal_source_configs/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/signal_source_configs/{signal_source_config_id}/".format(
        project_id=project_id,
		signal_source_config_id="<the signal source config id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "source_product": "session_replay",
  "source_type": "session_analysis_cluster",
  "enabled": true,
  "config": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "status": "string"
}

Update signal source configs

Required API key scopes

task:write

Path parameters

id
string
project_id
string

Request parameters

source_product
source_type
enabled
boolean
config

Response

Example request

PATCH /api/projects/:project_id/signal_source_configs/: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/signal_source_configs/:id/\
	-d source_product=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/signal_source_configs/{signal_source_config_id}/".format(
        project_id=project_id,
		signal_source_config_id="<the signal source config id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "source_product": "session_replay",
  "source_type": "session_analysis_cluster",
  "enabled": true,
  "config": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "status": "string"
}

Delete signal source configs

Required API key scopes

task:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/projects/:project_id/signal_source_configs/: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/signal_source_configs/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/signal_source_configs/{signal_source_config_id}/".format(
        project_id=project_id,
		signal_source_config_id="<the signal source config id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Signal Source

Endpoints

List all signal source configs

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create signal source configs

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve signal source configs

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update signal source configs

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete signal source configs

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions