Hog API Reference

Hog

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

Endpoints

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

Required API key scopes

hog_flow:read

Query parameters

created_at
string
created_by
integer
id
string
limit
integer
offset
integer
status
string
One of: "active""archived""draft"
updated_at
string

Response

Example request

GET /api/projects/:project_id/hog_flows
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_flows/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/".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",
      "name": "string",
      "description": "string",
      "version": 0,
      "status": "draft",
      "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": {},
        "role_at_organization": "engineering"
      },
      "updated_at": "2019-08-24T14:15:22Z",
      "trigger": null,
      "trigger_masking": null,
      "conversion": null,
      "exit_condition": "exit_on_conversion",
      "edges": null,
      "actions": null,
      "abort_action": "string",
      "variables": null,
      "billable_action_types": null,
      "user_access_level": "string"
    }
  ]
}

Create hog flows

Required API key scopes

hog_flow:write

Request parameters

name
stringnull
description
string
Default:
status
trigger_masking
conversion
exit_condition
edges
array
actions
array
variables
array

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "",
  "version": 0,
  "status": "draft",
  "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": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": {
    "filters": [
      {}
    ],
    "events": [
      {
        "filters": {
          "source": "events",
          "actions": [
            {}
          ],
          "events": [
            {}
          ],
          "data_warehouse": [
            {}
          ],
          "properties": [
            {}
          ],
          "bytecode": null,
          "transpiled": null,
          "filter_test_accounts": true,
          "bytecode_error": "string"
        }
      }
    ],
    "window_minutes": 0,
    "bytecode": null
  },
  "exit_condition": "exit_on_conversion",
  "edges": [
    {
      "to": "string",
      "type": "continue",
      "index": 0,
      "from": "string"
    }
  ],
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {}
        ],
        "events": [
          {}
        ],
        "data_warehouse": [
          {}
        ],
        "properties": [
          {}
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": {},
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null,
  "schedules": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "rrule": "string",
      "starts_at": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "variables": null,
      "status": "active",
      "next_run_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "user_access_level": "string",
  "draft": null,
  "draft_updated_at": "2019-08-24T14:15:22Z",
  "action_redirects": {
    "property1": "string",
    "property2": "string"
  }
}

Retrieve hog flows

Required API key scopes

hog_flow:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "",
  "version": 0,
  "status": "draft",
  "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": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": {
    "filters": [
      {}
    ],
    "events": [
      {
        "filters": {
          "source": "events",
          "actions": [
            {}
          ],
          "events": [
            {}
          ],
          "data_warehouse": [
            {}
          ],
          "properties": [
            {}
          ],
          "bytecode": null,
          "transpiled": null,
          "filter_test_accounts": true,
          "bytecode_error": "string"
        }
      }
    ],
    "window_minutes": 0,
    "bytecode": null
  },
  "exit_condition": "exit_on_conversion",
  "edges": [
    {
      "to": "string",
      "type": "continue",
      "index": 0,
      "from": "string"
    }
  ],
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {}
        ],
        "events": [
          {}
        ],
        "data_warehouse": [
          {}
        ],
        "properties": [
          {}
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": {},
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null,
  "schedules": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "rrule": "string",
      "starts_at": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "variables": null,
      "status": "active",
      "next_run_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "user_access_level": "string",
  "draft": null,
  "draft_updated_at": "2019-08-24T14:15:22Z",
  "action_redirects": {
    "property1": "string",
    "property2": "string"
  }
}

Update hog flows

Required API key scopes

hog_flow:write

Path parameters

id
string

Request parameters

name
stringnull
description
string
Default:
status
trigger_masking
conversion
exit_condition
edges
array
actions
array
variables
array

Response

Example request

PATCH /api/projects/:project_id/hog_flows/: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/hog_flows/:id/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/{hog_flow_id}/".format(
        project_id=project_id,
		hog_flow_id="<the hog flow id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "",
  "version": 0,
  "status": "draft",
  "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": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": {
    "filters": [
      {}
    ],
    "events": [
      {
        "filters": {
          "source": "events",
          "actions": [
            {}
          ],
          "events": [
            {}
          ],
          "data_warehouse": [
            {}
          ],
          "properties": [
            {}
          ],
          "bytecode": null,
          "transpiled": null,
          "filter_test_accounts": true,
          "bytecode_error": "string"
        }
      }
    ],
    "window_minutes": 0,
    "bytecode": null
  },
  "exit_condition": "exit_on_conversion",
  "edges": [
    {
      "to": "string",
      "type": "continue",
      "index": 0,
      "from": "string"
    }
  ],
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {}
        ],
        "events": [
          {}
        ],
        "data_warehouse": [
          {}
        ],
        "properties": [
          {}
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": {},
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null,
  "schedules": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "rrule": "string",
      "starts_at": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "variables": null,
      "status": "active",
      "next_run_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "user_access_level": "string",
  "draft": null,
  "draft_updated_at": "2019-08-24T14:15:22Z",
  "action_redirects": {
    "property1": "string",
    "property2": "string"
  }
}

Delete hog flows

Required API key scopes

hog_flow:write

Path parameters

id
string

Example request

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

Example response

Status 204 No response body

Retrieve hog flows assets

Required API key scopes

hog_flow:readperson:read

Path parameters

id
string

Query parameters

action_id
string
after
string
Default: -30d
before
string
distinct_id
string
invocation_id
string
limit
integer
Default: 50
offset
integer
Default: 0
parent_run_id
string
search
string

Example request

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

Example response

Status 200

RESPONSE
{
  "invocation_id": "string",
  "action_id": "string",
  "function_id": "string",
  "function_name": "string",
  "parent_run_id": "string",
  "kind": "string",
  "distinct_id": "string",
  "person_id": "string",
  "recipient": "string",
  "subject": "string",
  "status": "string",
  "sent_at": "2019-08-24T14:15:22Z"
}

Retrieve hog flows asset content

Required API key scopes

hog_flow:readperson:read

Path parameters

id
string

Query parameters

action_id
string
Default:
invocation_id
string

Example request

GET /api/projects/:project_id/hog_flows/:id/assets/content
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_flows/:id/assets/content/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/{hog_flow_id}/assets/content/".format(
        project_id=project_id,
		hog_flow_id="<the hog flow id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

List all hog flows batch jobs

Required API key scopes

hog_flow:read

Path parameters

id
string

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "waiting",
  "hog_flow": "a358a3bf-876e-4745-ab24-d5d741b3cd17",
  "filters": null,
  "variables": null,
  "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": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z"
}

Create hog flows batch jobs

Required API key scopes

hog_flow:writeperson:read

Path parameters

id
string

Request parameters

status
hog_flow
string
variables

Response

Example request

POST /api/projects/:project_id/hog_flows/:id/batch_jobs
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/hog_flows/:id/batch_jobs/\
	-d hog_flow="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/{hog_flow_id}/batch_jobs/".format(
        project_id=project_id,
		hog_flow_id="<the hog flow id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"hog_flow": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "waiting",
  "hog_flow": "a358a3bf-876e-4745-ab24-d5d741b3cd17",
  "filters": null,
  "variables": null,
  "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": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z"
}

Create hog flows discard draft

Required API key scopes

hog_flow:write

Path parameters

id
string

Response

Example request

POST /api/projects/:project_id/hog_flows/:id/discard_draft
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/hog_flows/:id/discard_draft/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/{hog_flow_id}/discard_draft/".format(
        project_id=project_id,
		hog_flow_id="<the hog flow id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "",
  "version": 0,
  "status": "draft",
  "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": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": {
    "filters": [
      {}
    ],
    "events": [
      {
        "filters": {
          "source": "events",
          "actions": [
            {}
          ],
          "events": [
            {}
          ],
          "data_warehouse": [
            {}
          ],
          "properties": [
            {}
          ],
          "bytecode": null,
          "transpiled": null,
          "filter_test_accounts": true,
          "bytecode_error": "string"
        }
      }
    ],
    "window_minutes": 0,
    "bytecode": null
  },
  "exit_condition": "exit_on_conversion",
  "edges": [
    {
      "to": "string",
      "type": "continue",
      "index": 0,
      "from": "string"
    }
  ],
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {}
        ],
        "events": [
          {}
        ],
        "data_warehouse": [
          {}
        ],
        "properties": [
          {}
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": {},
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null,
  "schedules": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "rrule": "string",
      "starts_at": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "variables": null,
      "status": "active",
      "next_run_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "user_access_level": "string",
  "draft": null,
  "draft_updated_at": "2019-08-24T14:15:22Z",
  "action_redirects": {
    "property1": "string",
    "property2": "string"
  }
}

Update hog flows graph

Required API key scopes

hog_flow:write

Path parameters

id
string

Request parameters

base_updated_at
string
operations
array

Response

Example request

PATCH /api/projects/:project_id/hog_flows/:id/graph
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/hog_flows/:id/graph/\
	-d base_updated_at="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/{hog_flow_id}/graph/".format(
        project_id=project_id,
		hog_flow_id="<the hog flow id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"base_updated_at": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "",
  "version": 0,
  "status": "draft",
  "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": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": {
    "filters": [
      {}
    ],
    "events": [
      {
        "filters": {
          "source": "events",
          "actions": [
            {}
          ],
          "events": [
            {}
          ],
          "data_warehouse": [
            {}
          ],
          "properties": [
            {}
          ],
          "bytecode": null,
          "transpiled": null,
          "filter_test_accounts": true,
          "bytecode_error": "string"
        }
      }
    ],
    "window_minutes": 0,
    "bytecode": null
  },
  "exit_condition": "exit_on_conversion",
  "edges": [
    {
      "to": "string",
      "type": "continue",
      "index": 0,
      "from": "string"
    }
  ],
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {}
        ],
        "events": [
          {}
        ],
        "data_warehouse": [
          {}
        ],
        "properties": [
          {}
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": {},
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null,
  "schedules": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "rrule": "string",
      "starts_at": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "variables": null,
      "status": "active",
      "next_run_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "user_access_level": "string",
  "draft": null,
  "draft_updated_at": "2019-08-24T14:15:22Z",
  "action_redirects": {
    "property1": "string",
    "property2": "string"
  }
}

Retrieve hog flows invocation results

Required API key scopes

hog_flow:readperson:read

Path parameters

id
string

Query parameters

after
string
Default: -7d
before
string
distinct_id
string
limit
integer
Default: 50
status
string

Example request

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

Example response

Status 200

RESPONSE
{
  "invocation_id": "string",
  "status": "string",
  "error_kind": "string",
  "error_message": "string",
  "distinct_id": "string",
  "person_id": "string",
  "scheduled_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "duration_ms": 0,
  "attempts": 0,
  "is_retry": true
}

Retrieve hog flows invocation result

Required API key scopes

hog_flow:readperson:read

Path parameters

id
string
invocation_id
string

Response

Example request

GET /api/projects/:project_id/hog_flows/:id/invocation_results/:invocation_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/hog_flows/:id/invocation_results/:invocation_id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/{hog_flow_id}/invocation_results/{invocation_id}/".format(
        project_id=project_id,
		hog_flow_id="<the hog flow id>",
		invocation_id="<the invocation id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "invocation_globals": {},
  "invocation_id": "string",
  "status": "string",
  "error_kind": "string",
  "error_message": "string",
  "distinct_id": "string",
  "person_id": "string",
  "scheduled_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "duration_ms": 0,
  "attempts": 0,
  "is_retry": true
}

Create hog flows invocations

Required API key scopes

hog_flow:writegroup:read

Path parameters

id
string

Request parameters

configuration
globals
object
mock_async_functions
boolean
Default: true
current_action_id
string
use_draft
boolean
Default: false

Example request

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

Example response

Status 200 No response body

Retrieve hog flows logs

Required API key scopes

hog_flow:read

Path parameters

id
string

Query parameters

after
string
before
string
instance_id
string
level
string
limit
integer
Default: 50
search
string

Example request

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

Example response

Status 200 No response body

Retrieve hog flows metrics

Required API key scopes

hog_flow:read

Path parameters

id
string

Query parameters

after
string
Default: -7d
before
string
breakdown_by
string
Default: kind
One of: "name""kind"
instance_id
string
interval
string
Default: day
One of: "hour""day""week"
kind
string
name
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "labels": [
    "string"
  ],
  "series": [
    {
      "name": "string",
      "values": [
        0
      ]
    }
  ]
}

Retrieve hog flows metrics totals

Required API key scopes

hog_flow:read

Path parameters

id
string

Query parameters

after
string
Default: -7d
before
string
breakdown_by
string
Default: kind
One of: "name""kind"
instance_id
string
interval
string
Default: day
One of: "hour""day""week"
kind
string
name
string

Response

Example request

GET /api/projects/:project_id/hog_flows/:id/metrics/totals
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/hog_flows/:id/metrics/totals/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/{hog_flow_id}/metrics/totals/".format(
        project_id=project_id,
		hog_flow_id="<the hog flow id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "totals": {
    "property1": 0,
    "property2": 0
  }
}

Create hog flows publish

Required API key scopes

hog_flow:write

Path parameters

id
string

Request parameters

confirm
boolean
Default: false
confirm_token
string

Response

Example request

POST /api/projects/:project_id/hog_flows/:id/publish
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/hog_flows/:id/publish/\
	-d confirm="boolean"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/{hog_flow_id}/publish/".format(
        project_id=project_id,
		hog_flow_id="<the hog flow id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"confirm": "boolean"
	}
).json()

Example response

Status 200

RESPONSE
{
  "published": true,
  "in_flight_runs": 0,
  "draft_updated_at": "2019-08-24T14:15:22Z",
  "confirm_token": "string",
  "impact": {
    "deleted_steps": [
      {
        "action_id": "string",
        "name": "string",
        "runs": 0,
        "moves_to": {
          "action_id": "string",
          "name": "string"
        },
        "exits": true
      }
    ],
    "position_unknown": 0,
    "empty_variables": [
      {
        "variable": "string",
        "set_by": "string",
        "referenced_by": [
          "string"
        ]
      }
    ],
    "schedule_conflicts": [
      {
        "schedule_id": "string",
        "variables": [
          "string"
        ]
      }
    ]
  },
  "workflow": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "",
    "version": 0,
    "status": "draft",
    "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": {},
      "role_at_organization": "engineering"
    },
    "updated_at": "2019-08-24T14:15:22Z",
    "trigger": null,
    "trigger_masking": {
      "ttl": 60,
      "threshold": 0,
      "hash": "string",
      "bytecode": null
    },
    "conversion": {
      "filters": [
        {}
      ],
      "events": [
        {
          "filters": {
            "source": "events",
            "actions": [
              {}
            ],
            "events": [
              {}
            ],
            "data_warehouse": [
              {}
            ],
            "properties": [
              {}
            ],
            "bytecode": null,
            "transpiled": null,
            "filter_test_accounts": true,
            "bytecode_error": "string"
          }
        }
      ],
      "window_minutes": 0,
      "bytecode": null
    },
    "exit_condition": "exit_on_conversion",
    "edges": [
      {
        "to": "string",
        "type": "continue",
        "index": 0,
        "from": "string"
      }
    ],
    "actions": [
      {
        "id": "string",
        "name": "string",
        "description": "",
        "on_error": "continue",
        "created_at": 0,
        "updated_at": 0,
        "filters": {
          "source": "events",
          "actions": [
            {}
          ],
          "events": [
            {}
          ],
          "data_warehouse": [
            {}
          ],
          "properties": [
            {}
          ],
          "bytecode": null,
          "transpiled": null,
          "filter_test_accounts": true,
          "bytecode_error": "string"
        },
        "type": "string",
        "config": {},
        "output_variable": null
      }
    ],
    "abort_action": "string",
    "variables": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "billable_action_types": null,
    "schedules": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "rrule": "string",
        "starts_at": "2019-08-24T14:15:22Z",
        "timezone": "string",
        "variables": null,
        "status": "active",
        "next_run_at": "2019-08-24T14:15:22Z",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
    "user_access_level": "string",
    "draft": null,
    "draft_updated_at": "2019-08-24T14:15:22Z",
    "action_redirects": {
      "property1": "string",
      "property2": "string"
    }
  }
}

Create hog flows rerun

Rerun past invocations of this hog flow from their stored payloads.

Same shape and semantics as the hog function rerun endpoint — proxies through to the CDP worker, which reads matching rows from ClickHouse, rehydrates from invocation_globals, and re-enqueues onto cyclotron with is_retry=1.

Because rerun replays historical event/person/group data, it requires person:read and group:read on top of hog_flow:write.

Required API key scopes

hog_flow:writeperson:readgroup:read

Path parameters

id
string

Request parameters

filter

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "rerun_job_id": "string",
  "queued_count": 0,
  "skipped_count": 0
}

Status 400

RESPONSE
{
  "rerun_job_id": "string",
  "queued_count": 0,
  "skipped_count": 0
}