Pipeline Transformation API Reference

Pipeline Transformation

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

Endpoints

`GET`	`/api/projects/:project_id/pipeline_transformation_configs/`
`POST`	`/api/projects/:project_id/pipeline_transformation_configs/`
`GET`	`/api/projects/:project_id/pipeline_transformation_configs/:id/`
`PATCH`	`/api/projects/:project_id/pipeline_transformation_configs/:id/`
`DELETE`	`/api/projects/:project_id/pipeline_transformation_configs/:id/`
`GET`	`/api/projects/:project_id/pipeline_transformation_configs/:id/activity/`
`GET`	`/api/projects/:project_id/pipeline_transformation_configs/:id/frontend/`
`POST`	`/api/projects/:project_id/pipeline_transformation_configs/:id/job/`
`POST`	`/api/projects/:project_id/pipeline_transformation_configs/:id/migrate/`
`PATCH`	`/api/projects/:project_id/pipeline_transformation_configs/rearrange/`

List all pipeline transformation configs

Required API key scopes

plugin:read

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

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

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,
      "plugin": 0,
      "enabled": true,
      "order": -2147483648,
      "config": "string",
      "error": "string",
      "team_id": 0,
      "plugin_info": "string",
      "delivery_rate_24h": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "description": "string",
      "deleted": true
    }
  ]
}

Create pipeline transformation configs

Required API key scopes

plugin:write

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

plugin
integer
enabled
boolean
order
integer
name
string
description
string
deleted
boolean

Response

Request

POST /api/projects/:project_id/pipeline_transformation_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/pipeline_transformation_configs/\
	-d plugin="integer",\
	-d order="integer"

Response

Status 201

RESPONSE

{
  "id": 0,
  "plugin": 0,
  "enabled": true,
  "order": -2147483648,
  "config": "string",
  "error": "string",
  "team_id": 0,
  "plugin_info": "string",
  "delivery_rate_24h": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "deleted": true
}

Retrieve pipeline transformation configs

Required API key scopes

plugin:read

Path parameters

id
integer
A unique integer value identifying this plugin config.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Request

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

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin": 0,
  "enabled": true,
  "order": -2147483648,
  "config": "string",
  "error": "string",
  "team_id": 0,
  "plugin_info": "string",
  "delivery_rate_24h": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "deleted": true
}

Update pipeline transformation configs

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin config.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

plugin
integer
enabled
boolean
order
integer
name
string
description
string
deleted
boolean

Response

Request

PATCH /api/projects/:project_id/pipeline_transformation_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/pipeline_transformation_configs/:id/\
	-d plugin="integer"

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin": 0,
  "enabled": true,
  "order": -2147483648,
  "config": "string",
  "error": "string",
  "team_id": 0,
  "plugin_info": "string",
  "delivery_rate_24h": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "deleted": true
}

Delete pipeline transformation configs

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin config.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request

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

Response

Status 204 No response body

Retrieve pipeline transformation configs activity

Path parameters

id
integer
A unique integer value identifying this plugin config.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request

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

Response

Status 200 No response body

Retrieve pipeline transformation configs frontend

Path parameters

id
integer
A unique integer value identifying this plugin config.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request

GET /api/projects/:project_id/pipeline_transformation_configs/:id/frontend

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

Response

Status 200 No response body

Create pipeline transformation configs job

Path parameters

id
integer
A unique integer value identifying this plugin config.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

plugin
integer
enabled
boolean
order
integer
name
string
description
string
deleted
boolean

Request

POST /api/projects/:project_id/pipeline_transformation_configs/:id/job

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/pipeline_transformation_configs/:id/job/\
	-d plugin="integer",\
	-d order="integer"

Response

Status 200 No response body

Create pipeline transformation configs migrate

Path parameters

id
integer
A unique integer value identifying this plugin config.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

plugin
integer
enabled
boolean
order
integer
name
string
description
string
deleted
boolean

Request

POST /api/projects/:project_id/pipeline_transformation_configs/:id/migrate

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/pipeline_transformation_configs/:id/migrate/\
	-d plugin="integer",\
	-d order="integer"

Response

Status 200 No response body

Update pipeline transformation configs rearrange

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

plugin
integer
enabled
boolean
order
integer
name
string
description
string
deleted
boolean

Request

PATCH /api/projects/:project_id/pipeline_transformation_configs/rearrange

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/pipeline_transformation_configs/rearrange/\
	-d plugin="integer"