Batch API Reference

Batch

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

Endpoints

`GET`
`GET`
`POST`
`GET`
`POST`
`GET`
`POST`
`GET`
`GET`
`POST`
`GET`
`POST`
`GET`

Retrieve batch exports test retrieve

Required API key scopes

INTERNAL

Path parameters

organization_id
string

Example request

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

Example response

Status 200 No response body

List all batch exports list

Required API key scopes

batch_export:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/batch_exports
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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/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",
      "team_id": 0,
      "name": "string",
      "model": "events",
      "destination": {
        "type": "S3",
        "config": null,
        "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,
          "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",
          "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
        }
      ],
      "hogql_query": "string",
      "schema": null,
      "filters": null,
      "timezone": "Africa/Abidjan",
      "offset_day": 6,
      "offset_hour": 23
    }
  ]
}

List all batch exports list

Required API key scopes

batch_export:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/batch_exports
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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/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",
      "team_id": 0,
      "name": "string",
      "model": "events",
      "destination": {
        "type": "S3",
        "config": null,
        "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,
          "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",
          "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
        }
      ],
      "hogql_query": "string",
      "schema": null,
      "filters": null,
      "timezone": "Africa/Abidjan",
      "offset_day": 6,
      "offset_hour": 23
    }
  ]
}

Create batch exports create

Required API key scopes

batch_export:write

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
timezone
offset_day
integer
offset_hour
integer

Response

Example request

POST /api/projects/:project_id/batch_exports
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/\
	-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/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null,
    "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,
      "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",
      "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
    }
  ],
  "hogql_query": "string",
  "schema": null,
  "filters": null,
  "timezone": "Africa/Abidjan",
  "offset_day": 6,
  "offset_hour": 23
}

Create batch exports create

Required API key scopes

batch_export:write

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
timezone
offset_day
integer
offset_hour
integer

Response

Example request

POST /api/projects/:project_id/batch_exports
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/\
	-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/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null,
    "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,
      "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",
      "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
    }
  ],
  "hogql_query": "string",
  "schema": null,
  "filters": null,
  "timezone": "Africa/Abidjan",
  "offset_day": 6,
  "offset_hour": 23
}

List all batch exports backfills list

ViewSet for BatchExportBackfill models.

Allows creating and reading backfills, but not updating or deleting them.

Required API key scopes

batch_export:read

Path parameters

batch_export_id
string
project_id
string

Query parameters

cursor
string
ordering
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "progress": "string",
      "start_at": "2019-08-24T14:15:22Z",
      "end_at": "2019-08-24T14:15:22Z",
      "status": "Cancelled",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "team": 0,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
    }
  ]
}

Create batch exports backfills create

Create a new backfill for a BatchExport.

Required API key scopes

batch_export:write

Path parameters

batch_export_id
string
project_id
string

Request parameters

start_at
string
end_at
string
status
finished_at
string
team
integer
batch_export
string

Response

Example request

POST /api/projects/:project_id/batch_exports/:batch_export_id/backfills
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/:batch_export_id/backfills/\
	-d status=undefined,\
	-d team="integer",\
	-d batch_export="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/".format(
        project_id=project_id,
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"team": "integer",
		"batch_export": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "progress": "string",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "status": "Cancelled",
  "created_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "team": 0,
  "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
}

Retrieve batch exports backfills retrieve

ViewSet for BatchExportBackfill models.

Allows creating and reading backfills, but not updating or deleting them.

Required API key scopes

batch_export:read

Path parameters

batch_export_id
string
id
string
project_id
string

Response

Example request

GET /api/projects/:project_id/batch_exports/:batch_export_id/backfills/: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/batch_exports/:batch_export_id/backfills/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/{batch_exports-3_id}/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "progress": "string",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "status": "Cancelled",
  "created_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "team": 0,
  "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
}

Create batch exports backfills cancel create

Cancel a batch export backfill.

Required API key scopes

batch_export:write

Path parameters

batch_export_id
string
id
string
project_id
string

Request parameters

start_at
string
end_at
string
status
finished_at
string
team
integer
batch_export
string

Example request

POST /api/projects/:project_id/batch_exports/:batch_export_id/backfills/:id/cancel
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/:batch_export_id/backfills/:id/cancel/\
	-d status=undefined,\
	-d team="integer",\
	-d batch_export="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/{batch_exports-3_id}/cancel/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"team": "integer",
		"batch_export": "string"
	}
).json()

Example response

Status 200 No response body

List all batch exports runs list

Required API key scopes

batch_export:read

Path parameters

batch_export_id
string
project_id
string

Query parameters

cursor
string
ordering
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -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",
      "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
    }
  ]
}

List all batch exports runs list

Required API key scopes

batch_export:read

Path parameters

batch_export_id
string
project_id
string

Query parameters

cursor
string
ordering
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -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",
      "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
    }
  ]
}

Retrieve batch exports runs retrieve

Required API key scopes

batch_export:read

Path parameters

batch_export_id
string
id
string
project_id
string

Response

Example request

GET /api/projects/:project_id/batch_exports/:batch_export_id/runs/: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/batch_exports/:batch_export_id/runs/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{batch_exports-3_id}/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "Cancelled",
  "records_completed": -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",
  "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
}

Retrieve batch exports runs retrieve

Required API key scopes

batch_export:read

Path parameters

batch_export_id
string
id
string
project_id
string

Response

Example request

GET /api/projects/:project_id/batch_exports/:batch_export_id/runs/: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/batch_exports/:batch_export_id/runs/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{batch_exports-3_id}/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "Cancelled",
  "records_completed": -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",
  "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
}

Create batch exports runs cancel create

Cancel a batch export run.

Required API key scopes

batch_export:write

Path parameters

batch_export_id
string
id
string
project_id
string

Request parameters

status
records_completed
integer
latest_error
string
data_interval_start
string
data_interval_end
string
cursor
string
finished_at
string
records_total_count
integer
bytes_exported
integer
backfill
string

Example request

POST /api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/cancel
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/:batch_export_id/runs/:id/cancel/\
	-d status=undefined,\
	-d data_interval_end="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{batch_exports-3_id}/cancel/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"data_interval_end": "string"
	}
).json()

Example response

Status 200 No response body

Create batch exports runs cancel create

Cancel a batch export run.

Required API key scopes

batch_export:write

Path parameters

batch_export_id
string
id
string
project_id
string

Request parameters

status
records_completed
integer
latest_error
string
data_interval_start
string
data_interval_end
string
cursor
string
finished_at
string
records_total_count
integer
bytes_exported
integer
backfill
string

Example request

POST /api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/cancel
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/:batch_export_id/runs/:id/cancel/\
	-d status=undefined,\
	-d data_interval_end="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{batch_exports-3_id}/cancel/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"data_interval_end": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve batch exports runs logs retrieve

Path parameters

batch_export_id
string
id
string
project_id
string

Example request

GET /api/projects/:project_id/batch_exports/:batch_export_id/runs/: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/batch_exports/:batch_export_id/runs/:id/logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{batch_exports-3_id}/logs/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve batch exports runs logs retrieve

Path parameters

batch_export_id
string
id
string
project_id
string

Example request

GET /api/projects/:project_id/batch_exports/:batch_export_id/runs/: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/batch_exports/:batch_export_id/runs/:id/logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{batch_exports-3_id}/logs/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create batch exports runs retry create

Retry a batch export run.

We use the same underlying mechanism as when backfilling a batch export, as retrying a run is the same as backfilling one run.

Required API key scopes

batch_export:write

Path parameters

batch_export_id
string
id
string
project_id
string

Request parameters

status
records_completed
integer
latest_error
string
data_interval_start
string
data_interval_end
string
cursor
string
finished_at
string
records_total_count
integer
bytes_exported
integer
backfill
string

Example request

POST /api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/retry
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/:batch_export_id/runs/:id/retry/\
	-d status=undefined,\
	-d data_interval_end="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{batch_exports-3_id}/retry/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"data_interval_end": "string"
	}
).json()

Example response

Status 200 No response body

Create batch exports runs retry create

Retry a batch export run.

We use the same underlying mechanism as when backfilling a batch export, as retrying a run is the same as backfilling one run.

Required API key scopes

batch_export:write

Path parameters

batch_export_id
string
id
string
project_id
string

Request parameters

status
records_completed
integer
latest_error
string
data_interval_start
string
data_interval_end
string
cursor
string
finished_at
string
records_total_count
integer
bytes_exported
integer
backfill
string

Example request

POST /api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/retry
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/:batch_export_id/runs/:id/retry/\
	-d status=undefined,\
	-d data_interval_end="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{batch_exports-3_id}/retry/".format(
        project_id=project_id,
		batch_exports-3_id="<the batch exports-3 id>",
		batch_export_id="<the batch export id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"data_interval_end": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve batch exports retrieve

Required API key scopes

batch_export:read

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null,
    "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,
      "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",
      "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
    }
  ],
  "hogql_query": "string",
  "schema": null,
  "filters": null,
  "timezone": "Africa/Abidjan",
  "offset_day": 6,
  "offset_hour": 23
}