Hog Function API Reference

Hog Function

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

Endpoints

`GET`
`GET`
`GET`

List all hog function templates

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer
template_id
string
type
string
types
string

Response

Example request

GET /api/projects/:project_id/hog_function_templates
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_function_templates/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_function_templates/".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": "string",
      "name": "string",
      "description": "string",
      "code": "string",
      "code_language": "string",
      "inputs_schema": null,
      "type": "string",
      "status": "string",
      "category": null,
      "free": true,
      "icon_url": "string",
      "filters": null,
      "masking": null,
      "mapping_templates": [
        {
          "name": "string",
          "include_by_default": true,
          "use_all_events_by_default": true,
          "filters": null,
          "inputs": null,
          "inputs_schema": null
        }
      ]
    }
  ]
}

List all hog function templates

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer
template_id
string
type
string
types
string

Response

Example request

GET /api/projects/:project_id/hog_function_templates
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_function_templates/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/hog_function_templates/".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": "string",
      "name": "string",
      "description": "string",
      "code": "string",
      "code_language": "string",
      "inputs_schema": null,
      "type": "string",
      "status": "string",
      "category": null,
      "free": true,
      "icon_url": "string",
      "filters": null,
      "masking": null,
      "mapping_templates": [
        {
          "name": "string",
          "include_by_default": true,
          "use_all_events_by_default": true,
          "filters": null,
          "inputs": null,
          "inputs_schema": null
        }
      ]
    }
  ]
}

Retrieve hog function templates

Path parameters

project_id
string
template_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "string",
  "name": "string",
  "description": "string",
  "code": "string",
  "code_language": "string",
  "inputs_schema": null,
  "type": "string",
  "status": "string",
  "category": null,
  "free": true,
  "icon_url": "string",
  "filters": null,
  "masking": null,
  "mapping_templates": [
    {
      "name": "string",
      "include_by_default": true,
      "use_all_events_by_default": true,
      "filters": null,
      "inputs": null,
      "inputs_schema": null
    }
  ]
}

Retrieve hog function templates

Path parameters

project_id
string
template_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "string",
  "name": "string",
  "description": "string",
  "code": "string",
  "code_language": "string",
  "inputs_schema": null,
  "type": "string",
  "status": "string",
  "category": null,
  "free": true,
  "icon_url": "string",
  "filters": null,
  "masking": null,
  "mapping_templates": [
    {
      "name": "string",
      "include_by_default": true,
      "use_all_events_by_default": true,
      "filters": null,
      "inputs": null,
      "inputs_schema": null
    }
  ]
}

List all public hog function templates

Query parameters

limit
integer
offset
integer
template_id
string
type
string
types
string

Response

Example request

GET /api/public_hog_function_templates
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/public_hog_function_templates/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/public_hog_function_templates/".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": "string",
      "name": "string",
      "description": "string",
      "code": "string",
      "code_language": "string",
      "inputs_schema": null,
      "type": "string",
      "status": "string",
      "category": null,
      "free": true,
      "icon_url": "string",
      "filters": null,
      "masking": null,
      "mapping_templates": [
        {
          "name": "string",
          "include_by_default": true,
          "use_all_events_by_default": true,
          "filters": null,
          "inputs": null,
          "inputs_schema": null
        }
      ]
    }
  ]
}

Hog Function

Endpoints

List all hog function templates

Path parameters

Query parameters

Response

Example request

Example response

Status 200

List all hog function templates

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Retrieve hog function templates

Path parameters

Response

Example request

Example response

Status 200

Retrieve hog function templates

Path parameters

Response

Example request

Example response

Status 200

List all public hog function templates

Query parameters

Response

Example request

Example response

Status 200

Community questions