Hog API Reference

Hog

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

Endpoints

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

Retrieve hog flows

Required API key scopes

hog_flow:read

Path parameters

id
string
project_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": "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": null,
  "exit_condition": "exit_on_conversion",
  "edges": null,
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "data_warehouse": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": null,
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null
}

Update hog flows

Required API key scopes

hog_flow:write

Path parameters

id
string
project_id
string

Request parameters

name
string
description
string
status
trigger
trigger_masking
conversion
exit_condition
edges
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"
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"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": null,
  "exit_condition": "exit_on_conversion",
  "edges": null,
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "data_warehouse": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": null,
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null
}

Delete hog flows

Required API key scopes

hog_flow:write

Path parameters

id
string
project_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 batch jobs

Path parameters

id
string
project_id
string

Response

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",
  "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": null,
  "exit_condition": "exit_on_conversion",
  "edges": null,
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "data_warehouse": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": null,
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null
}

Create hog flows batch jobs

Path parameters

id
string
project_id
string

Request parameters

name
string
description
string
status
trigger
trigger_masking
conversion
exit_condition
edges
actions
array
variables
array

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 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/{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={
		"actions": "array"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": null,
  "exit_condition": "exit_on_conversion",
  "edges": null,
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "data_warehouse": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": null,
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null
}

Create hog flows invocations

Path parameters

id
string
project_id
string

Request parameters

name
string
description
string
status
trigger
trigger_masking
conversion
exit_condition
edges
actions
array
variables
array

Response

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 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/{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={
		"actions": "array"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": null,
  "exit_condition": "exit_on_conversion",
  "edges": null,
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "data_warehouse": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": null,
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null
}

Retrieve hog flows logs

Path parameters

id
string
project_id
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

Retrieve hog flows metrics

Path parameters

id
string
project_id
string

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_flows-2_id}/metrics/".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

Retrieve hog flows metrics totals

Path parameters

id
string
project_id
string

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_flows-2_id}/metrics/totals/".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

List all hog flows schedules

Path parameters

id
string
project_id
string

Query parameters

created_at
string
created_by
integer
id
string
limit
integer
offset
integer
updated_at
string

Response

Example request

GET /api/projects/:project_id/hog_flows/:id/schedules
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/schedules/
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}/schedules/".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
{
  "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",
      "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"
    }
  ]
}

Create hog flows schedules

Path parameters

id
string
project_id
string

Query parameters

created_at
string
created_by
integer
id
string
limit
integer
offset
integer
updated_at
string

Request parameters

name
string
description
string
status
trigger
trigger_masking
conversion
exit_condition
edges
actions
array
variables
array

Response

Example request

POST /api/projects/:project_id/hog_flows/:id/schedules
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/schedules/\
	-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/{hog_flows-2_id}/schedules/".format(
        project_id=project_id,
		hog_flows-2_id="<the hog flows-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"actions": "array"
	}
).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",
      "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"
    }
  ]
}

Update hog flows schedules

Path parameters

id
string
project_id
string
schedule_id
string

Request parameters

name
string
description
string
status
trigger
trigger_masking
conversion
exit_condition
edges
actions
array
variables
array

Response

Example request

PATCH /api/projects/:project_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/projects/:project_id/hog_flows/:id/schedules/:schedule_id/\
	-d name="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_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={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": null,
  "exit_condition": "exit_on_conversion",
  "edges": null,
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "data_warehouse": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": null,
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null
}

Delete hog flows schedules

Path parameters

id
string
project_id
string
schedule_id
string

Example request

DELETE /api/projects/:project_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/projects/:project_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/projects/{project_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 hog flows bulk delete

Path parameters

project_id
string

Request parameters

name
string
description
string
status
trigger
trigger_masking
conversion
exit_condition
edges
actions
array
variables
array

Response

Example request

POST /api/projects/:project_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/projects/:project_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/projects/{project_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": "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "trigger": null,
  "trigger_masking": {
    "ttl": 60,
    "threshold": 0,
    "hash": "string",
    "bytecode": null
  },
  "conversion": null,
  "exit_condition": "exit_on_conversion",
  "edges": null,
  "actions": [
    {
      "id": "string",
      "name": "string",
      "description": "",
      "on_error": "continue",
      "created_at": 0,
      "updated_at": 0,
      "filters": {
        "source": "events",
        "actions": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "events": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "data_warehouse": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "properties": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "bytecode": null,
        "transpiled": null,
        "filter_test_accounts": true,
        "bytecode_error": "string"
      },
      "type": "string",
      "config": null,
      "output_variable": null
    }
  ],
  "abort_action": "string",
  "variables": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "billable_action_types": null
}

Create hog flows user blast radius

Path parameters

project_id
string

Request parameters

filters
object
group_type_index
integer

Response

Example request

POST /api/projects/:project_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/projects/:project_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/projects/{project_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
}