Batch API Reference

Batch

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

Endpoints

`POST`
`GET`

Create batch exports run test step new create

Required API key scopes

INTERNAL

Path parameters

project_id
string

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
string
start_at
string
end_at
string
hogql_query
string
filters

Example request

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

Example response

Status 200 No response body

Create batch exports run test step new create

Required API key scopes

INTERNAL

Path parameters

project_id
string

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
string
start_at
string
end_at
string
hogql_query
string
filters

Example request

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

Example response

Status 200 No response body

Retrieve batch exports test retrieve

Required API key scopes

INTERNAL

Path parameters

project_id
string

Example request

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

Example response

Status 200 No response body

Retrieve batch exports test retrieve

Required API key scopes

INTERNAL

Path parameters

project_id
string

Example request

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

Batch

Endpoints

Create batch exports run test step new create

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create batch exports run test step new create

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve batch exports test retrieve

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve batch exports test retrieve

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Community questions