Hog API Reference

Hog

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

Endpoints

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

← Previous pageNext page →

Update environments hog flows schedules

Required API key scopes

hog_flow:write

Path parameters

id
string
schedule_id
string

Request parameters

rrule
string
starts_at
string
timezone
string
variables

Response

Example request

PATCH /api/environments/:environment_id/hog_flows/:id/schedules/:schedule_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/hog_flows/:id/schedules/:schedule_id/\
	-d rrule="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/hog_flows/{hog_flows-2_id}/schedules/{schedule_id}/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 id>",
		schedule_id="<the schedule id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"rrule": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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"
}

Delete environments hog flows schedules

Required API key scopes

hog_flow:write

Path parameters

id
string
schedule_id
string

Example request

DELETE /api/environments/:environment_id/hog_flows/:id/schedules/:schedule_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/hog_flows/:id/schedules/:schedule_id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{environment_id}/hog_flows/{hog_flows-2_id}/schedules/{schedule_id}/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 id>",
		schedule_id="<the schedule id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Create environments hog flows bulk delete

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

Retrieve environments hog flows metrics global

Required API key scopes

hog_flow:read

Query parameters

after
string
Default: -7d
before
string

Example request

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

Example response

Status 200

RESPONSE
{
  "workflow_id": "string",
  "succeeded": 0,
  "failed": 0
}

Create environments hog flows user blast radius

Required API key scopes

hog_flow:readperson:read

Request parameters

filters
object
group_type_index
integernull
dedupe_key

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "affected": 0,
  "total": 0,
  "limit": 0,
  "dedupe_key": "email"
}

List all hog flows

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"
}

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_flows-2_id}/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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"
}

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_flows-2_id}/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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"
}

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_flows-2_id}/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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_flows-2_id}/assets/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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_flows-2_id}/assets/content/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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_flows-2_id}/batch_jobs/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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:write

Path parameters

id
string

Request parameters

status
hog_flow
string
filters
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_flows-2_id}/batch_jobs/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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"
}

Update hog flows graph

Required API key scopes

hog_flow:write

Path parameters

id
string

Request parameters

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 operations="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/hog_flows/{hog_flows-2_id}/graph/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"operations": "array"
	}
).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"
}

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_flows-2_id}/invocation_results/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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_flows-2_id}/invocation_results/{invocation_id}/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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

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_flows-2_id}/invocations/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 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_flows-2_id}/logs/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

← Previous pageNext page →