Batch API Reference

Batch

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

Endpoints

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

← Previous pageNext page →

Update environments batch exports

Required API key scopes

batch_export:write

Path parameters

id
string

Request parameters

name
string
model
destination
interval
paused
boolean
hogql_query
string
filters
timezone
stringnull
offset_day
integernull
offset_hour
integernull

Response

Example request

PATCH /api/environments/:environment_id/batch_exports/: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/batch_exports/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/batch_exports/{batch_exports-2_id}/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": {
      "http_path": "string",
      "catalog": "string",
      "schema": "string",
      "table_name": "string",
      "use_variant_type": true,
      "use_automatic_schema_evolution": true
    },
    "integration": 0,
    "integration_id": 0
  },
  "interval": "hour",
  "paused": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "last_paused_at": "2019-08-24T14:15:22Z",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "latest_runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -2147483648,
      "records_failed": -2147483648,
      "latest_error": "string",
      "data_interval_start": "2019-08-24T14:15:22Z",
      "data_interval_end": "2019-08-24T14:15:22Z",
      "cursor": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "records_total_count": -2147483648,
      "bytes_exported": -9223372036854776000,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f",
      "batch_export_on_demand": "d6e8418b-6c8d-4d3d-8dbd-ab165d4dc1b8",
      "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
    }
  ],
  "hogql_query": "string",
  "schema": null,
  "filters": null,
  "timezone": "Africa/Abidjan",
  "offset_day": 6,
  "offset_hour": 23
}

Update environments batch exports

Required API key scopes

batch_export:write

Path parameters

id
string

Request parameters

name
string
model
destination
interval
paused
boolean
hogql_query
string
filters
timezone
stringnull
offset_day
integernull
offset_hour
integernull

Response

Example request

PATCH /api/environments/:environment_id/batch_exports/: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/batch_exports/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/batch_exports/{batch_exports-2_id}/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": {
      "http_path": "string",
      "catalog": "string",
      "schema": "string",
      "table_name": "string",
      "use_variant_type": true,
      "use_automatic_schema_evolution": true
    },
    "integration": 0,
    "integration_id": 0
  },
  "interval": "hour",
  "paused": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "last_paused_at": "2019-08-24T14:15:22Z",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "latest_runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -2147483648,
      "records_failed": -2147483648,
      "latest_error": "string",
      "data_interval_start": "2019-08-24T14:15:22Z",
      "data_interval_end": "2019-08-24T14:15:22Z",
      "cursor": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "records_total_count": -2147483648,
      "bytes_exported": -9223372036854776000,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f",
      "batch_export_on_demand": "d6e8418b-6c8d-4d3d-8dbd-ab165d4dc1b8",
      "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
    }
  ],
  "hogql_query": "string",
  "schema": null,
  "filters": null,
  "timezone": "Africa/Abidjan",
  "offset_day": 6,
  "offset_hour": 23
}

Delete environments batch exports

Required API key scopes

batch_export:write

Path parameters

id
string

Example request

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

Example response

Status 204 No response body

Delete environments batch exports

Required API key scopes

batch_export:write

Path parameters

id
string

Example request

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

Example response

Status 204 No response body

Retrieve environments batch exports logs

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/environments/:environment_id/batch_exports/:id/logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/batch_exports/:id/logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/batch_exports/{batch_exports-2_id}/logs/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments batch exports logs

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/environments/:environment_id/batch_exports/:id/logs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/batch_exports/:id/logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/batch_exports/{batch_exports-2_id}/logs/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create environments batch exports pause

Pause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
stringnull
start_at
stringnull
end_at
stringnull
hogql_query
string
filters
timezone
offset_day
integernull
offset_hour
integernull

Example request

POST /api/environments/:environment_id/batch_exports/:id/pause
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/batch_exports/:id/pause/\
	-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/environments/{environment_id}/batch_exports/{batch_exports-2_id}/pause/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

Create environments batch exports pause

Pause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
stringnull
start_at
stringnull
end_at
stringnull
hogql_query
string
filters
timezone
offset_day
integernull
offset_hour
integernull

Example request

POST /api/environments/:environment_id/batch_exports/:id/pause
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/batch_exports/:id/pause/\
	-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/environments/{environment_id}/batch_exports/{batch_exports-2_id}/pause/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

Create environments batch exports run test step

Required API key scopes

batch_export:write

Path parameters

id
string

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
stringnull
start_at
stringnull
end_at
stringnull
hogql_query
string
filters
timezone
offset_day
integernull
offset_hour
integernull

Example request

POST /api/environments/:environment_id/batch_exports/:id/run_test_step
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/batch_exports/:id/run_test_step/\
	-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/environments/{environment_id}/batch_exports/{batch_exports-2_id}/run_test_step/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

Create environments batch exports run test step

Required API key scopes

batch_export:write

Path parameters

id
string

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
stringnull
start_at
stringnull
end_at
stringnull
hogql_query
string
filters
timezone
offset_day
integernull
offset_hour
integernull

Example request

POST /api/environments/:environment_id/batch_exports/:id/run_test_step
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/batch_exports/:id/run_test_step/\
	-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/environments/{environment_id}/batch_exports/{batch_exports-2_id}/run_test_step/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

Create environments batch exports unpause

Unpause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
stringnull
start_at
stringnull
end_at
stringnull
hogql_query
string
filters
timezone
offset_day
integernull
offset_hour
integernull

Example request

POST /api/environments/:environment_id/batch_exports/:id/unpause
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/batch_exports/:id/unpause/\
	-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/environments/{environment_id}/batch_exports/{batch_exports-2_id}/unpause/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

Create environments batch exports unpause

Unpause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
stringnull
start_at
stringnull
end_at
stringnull
hogql_query
string
filters
timezone
offset_day
integernull
offset_hour
integernull

Example request

POST /api/environments/:environment_id/batch_exports/:id/unpause
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/batch_exports/:id/unpause/\
	-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/environments/{environment_id}/batch_exports/{batch_exports-2_id}/unpause/".format(
        project_id=project_id,
		batch_exports-2_id="<the batch exports-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

Create environments batch exports run test step new

Required API key scopes

batch_export:write

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
stringnull
start_at
stringnull
end_at
stringnull
hogql_query
string
filters
timezone
offset_day
integernull
offset_hour
integernull

Example request

POST /api/environments/:environment_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/environments/:environment_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/environments/{environment_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 environments batch exports run test step new

Required API key scopes

batch_export:write

Request parameters

name
string
model
destination
interval
paused
boolean
last_paused_at
stringnull
start_at
stringnull
end_at
stringnull
hogql_query
string
filters
timezone
offset_day
integernull
offset_hour
integernull

Example request

POST /api/environments/:environment_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/environments/:environment_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/environments/{environment_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 environments batch exports test

Required API key scopes

batch_export:read

Example request

GET /api/environments/:environment_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/environments/:environment_id/batch_exports/test/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/batch_exports/test/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments batch exports test

Required API key scopes

batch_export:read

Example request

GET /api/environments/:environment_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/environments/:environment_id/batch_exports/test/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/batch_exports/test/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

List all environments file download batch exports

Required API key scopes

batch_export:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:environment_id/file_download_batch_exports
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/file_download_batch_exports/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/file_download_batch_exports/".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",
      "status": "Cancelled"
    }
  ]
}

Create environments file download batch exports

Create and start a batch export on demand run to download a file.

Required API key scopes

batch_export:write

Response

Example request

Example response

Status 202

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

← Previous pageNext page →