Batch

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

Endpoints

    GET/api/organizations/:organization_id/batch_exports/
    POST/api/organizations/:organization_id/batch_exports/
    GET/api/organizations/:organization_id/batch_exports/:id/
    PATCH/api/organizations/:organization_id/batch_exports/:id/
    DELETE/api/organizations/:organization_id/batch_exports/:id/
    POST/api/organizations/:organization_id/batch_exports/:id/backfill/
    GET/api/organizations/:organization_id/batch_exports/:id/logs/
    POST/api/organizations/:organization_id/batch_exports/:id/pause/
    POST/api/organizations/:organization_id/batch_exports/:id/unpause/
    GET/api/projects/:project_id/batch_exports/
    POST/api/projects/:project_id/batch_exports/
    GET/api/projects/:project_id/batch_exports/:batch_export_id/runs/
    GET/api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/
    POST/api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/cancel/
    GET/api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/logs/
    POST/api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/retry/
    GET/api/projects/:project_id/batch_exports/:id/
    PATCH/api/projects/:project_id/batch_exports/:id/

    List all batch exports

    Required API key scopes

    batch_export:read

    Path parameters

    • organization_id
      string

    Query parameters

    • limit
      integer

      Number of results to return per page.

    • offset
      integer

      The initial index from which to return the results.

    Response


    Request

    GET /api/organizations/:organization_id/batch_exports
    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/

    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
          },
          "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,
              "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
            }
          ],
          "hogql_query": "string",
          "schema": null
        }
      ]
    }

    Create batch exports

    Required API key scopes

    batch_export:write

    Path parameters

    • organization_id
      string

    Request parameters

    • name
      string

      A human-readable name for this BatchExport.

    • model

      Which model this BatchExport is exporting.

      • events - Events
      • persons - Persons
    • destination
    • interval
    • paused
      boolean

      Whether this BatchExport is paused or not.

    • last_paused_at
      string

      The timestamp at which this BatchExport was last paused.

    • start_at
      string

      Time before which any Batch Export runs won't be triggered.

    • end_at
      string

      Time after which any Batch Export runs won't be triggered.

    • hogql_query
      string

    Response


    Request

    POST /api/organizations/:organization_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/organizations/:organization_id/batch_exports/\
    	-d name="string",\
    	-d destination=undefined,\
    	-d interval=undefined

    Response

    Status 201
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "team_id": 0,
      "name": "string",
      "model": "events",
      "destination": {
        "type": "S3",
        "config": null
      },
      "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,
          "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
        }
      ],
      "hogql_query": "string",
      "schema": null
    }

    Retrieve batch exports

    Required API key scopes

    batch_export:read

    Path parameters

    • id
      string

      A UUID string identifying this batch export.

    • organization_id
      string

    Response


    Request

    GET /api/organizations/:organization_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/organizations/:organization_id/batch_exports/:id/

    Response

    Status 200
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "team_id": 0,
      "name": "string",
      "model": "events",
      "destination": {
        "type": "S3",
        "config": null
      },
      "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,
          "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
        }
      ],
      "hogql_query": "string",
      "schema": null
    }

    Update batch exports

    Required API key scopes

    batch_export:write

    Path parameters

    • id
      string

      A UUID string identifying this batch export.

    • organization_id
      string

    Request parameters

    • name
      string

      A human-readable name for this BatchExport.

    • model

      Which model this BatchExport is exporting.

      • events - Events
      • persons - Persons
    • destination
    • interval
    • paused
      boolean

      Whether this BatchExport is paused or not.

    • last_paused_at
      string

      The timestamp at which this BatchExport was last paused.

    • start_at
      string

      Time before which any Batch Export runs won't be triggered.

    • end_at
      string

      Time after which any Batch Export runs won't be triggered.

    • hogql_query
      string

    Response


    Request

    PATCH /api/organizations/:organization_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/organizations/:organization_id/batch_exports/:id/\
    	-d team_id="integer"

    Response

    Status 200
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "team_id": 0,
      "name": "string",
      "model": "events",
      "destination": {
        "type": "S3",
        "config": null
      },
      "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,
          "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
        }
      ],
      "hogql_query": "string",
      "schema": null
    }

    Delete batch exports

    Required API key scopes

    batch_export:write

    Path parameters

    • id
      string

      A UUID string identifying this batch export.

    • organization_id
      string

    Request

    DELETE /api/organizations/:organization_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/organizations/:organization_id/batch_exports/:id/

    Response

    Status 204 No response body

    Create batch exports backfill

    Trigger a backfill for a BatchExport.

    Required API key scopes

    batch_export:write

    Path parameters

    • id
      string

      A UUID string identifying this batch export.

    • organization_id
      string

    Request parameters

    • name
      string

      A human-readable name for this BatchExport.

    • model

      Which model this BatchExport is exporting.

      • events - Events
      • persons - Persons
    • destination
    • interval
    • paused
      boolean

      Whether this BatchExport is paused or not.

    • last_paused_at
      string

      The timestamp at which this BatchExport was last paused.

    • start_at
      string

      Time before which any Batch Export runs won't be triggered.

    • end_at
      string

      Time after which any Batch Export runs won't be triggered.

    • hogql_query
      string

    Request

    POST /api/organizations/:organization_id/batch_exports/:id/backfill
    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/organizations/:organization_id/batch_exports/:id/backfill/\
    	-d name="string",\
    	-d destination=undefined,\
    	-d interval=undefined

    Response

    Status 200 No response body

    Retrieve batch exports logs

    Path parameters

    • id
      string

      A UUID string identifying this batch export.

    • organization_id
      string

    Request

    GET /api/organizations/:organization_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/organizations/:organization_id/batch_exports/:id/logs/

    Response

    Status 200 No response body

    Create batch exports pause

    Pause a BatchExport.

    Required API key scopes

    batch_export:write

    Path parameters

    • id
      string

      A UUID string identifying this batch export.

    • organization_id
      string

    Request parameters

    • name
      string

      A human-readable name for this BatchExport.

    • model

      Which model this BatchExport is exporting.

      • events - Events
      • persons - Persons
    • destination
    • interval
    • paused
      boolean

      Whether this BatchExport is paused or not.

    • last_paused_at
      string

      The timestamp at which this BatchExport was last paused.

    • start_at
      string

      Time before which any Batch Export runs won't be triggered.

    • end_at
      string

      Time after which any Batch Export runs won't be triggered.

    • hogql_query
      string

    Request

    POST /api/organizations/:organization_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/organizations/:organization_id/batch_exports/:id/pause/\
    	-d name="string",\
    	-d destination=undefined,\
    	-d interval=undefined

    Response

    Status 200 No response body

    Create batch exports unpause

    Unpause a BatchExport.

    Required API key scopes

    batch_export:write

    Path parameters

    • id
      string

      A UUID string identifying this batch export.

    • organization_id
      string

    Request parameters

    • name
      string

      A human-readable name for this BatchExport.

    • model

      Which model this BatchExport is exporting.

      • events - Events
      • persons - Persons
    • destination
    • interval
    • paused
      boolean

      Whether this BatchExport is paused or not.

    • last_paused_at
      string

      The timestamp at which this BatchExport was last paused.

    • start_at
      string

      Time before which any Batch Export runs won't be triggered.

    • end_at
      string

      Time after which any Batch Export runs won't be triggered.

    • hogql_query
      string

    Request

    POST /api/organizations/:organization_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/organizations/:organization_id/batch_exports/:id/unpause/\
    	-d name="string",\
    	-d destination=undefined,\
    	-d interval=undefined

    Response

    Status 200 No response body

    List all batch exports list

    Required API key scopes

    batch_export:read

    Path parameters

    • project_id
      string

      Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

    Query parameters

    • limit
      integer

      Number of results to return per page.

    • offset
      integer

      The initial index from which to return the results.

    Response


    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/

    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
          },
          "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,
              "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
            }
          ],
          "hogql_query": "string",
          "schema": null
        }
      ]
    }

    Create batch exports create

    Required API key scopes

    batch_export:write

    Path parameters

    • project_id
      string

      Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

    Request parameters

    • name
      string

      A human-readable name for this BatchExport.

    • model

      Which model this BatchExport is exporting.

      • events - Events
      • persons - Persons
    • destination
    • interval
    • paused
      boolean

      Whether this BatchExport is paused or not.

    • last_paused_at
      string

      The timestamp at which this BatchExport was last paused.

    • start_at
      string

      Time before which any Batch Export runs won't be triggered.

    • end_at
      string

      Time after which any Batch Export runs won't be triggered.

    • hogql_query
      string

    Response


    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

    Response

    Status 201
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "team_id": 0,
      "name": "string",
      "model": "events",
      "destination": {
        "type": "S3",
        "config": null
      },
      "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,
          "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
        }
      ],
      "hogql_query": "string",
      "schema": null
    }

    List all batch exports runs

    Required API key scopes

    batch_export:read

    Path parameters

    • batch_export_id
      string

      The BatchExport this run belongs to.

    • project_id
      string

      Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

    Query parameters

    • cursor
      string

      The pagination cursor value.

    • ordering
      string

      Which field to use when ordering the results.

    Response


    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/

    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,
          "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
        }
      ]
    }

    Retrieve batch exports runs

    Required API key scopes

    batch_export:read

    Path parameters

    • batch_export_id
      string

      The BatchExport this run belongs to.

    • id
      string

      A UUID string identifying this batch export run.

    • project_id
      string

      Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

    Response


    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/

    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,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
    }

    Create batch exports runs cancel

    Cancel a batch export run.

    Required API key scopes

    batch_export:write

    Path parameters

    • batch_export_id
      string

      The BatchExport this run belongs to.

    • id
      string

      A UUID string identifying this batch export run.

    • project_id
      string

      Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

    Request parameters

    • status

      The status of this run.

      • Cancelled - Cancelled
      • Completed - Completed
      • ContinuedAsNew - Continued As New
      • Failed - Failed
      • FailedRetryable - Failed Retryable
      • Terminated - Terminated
      • TimedOut - Timedout
      • Running - Running
      • Starting - Starting
    • records_completed
      integer

      The number of records that have been exported.

    • latest_error
      string

      The latest error that occurred during this run.

    • data_interval_start
      string

      The start of the data interval.

    • data_interval_end
      string

      The end of the data interval.

    • cursor
      string

      An opaque cursor that may be used to resume.

    • finished_at
      string

      The timestamp at which this BatchExportRun finished, successfully or not.

    • records_total_count
      integer

      The total count of records that should be exported in this BatchExportRun.

    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"

    Response

    Status 200 No response body

    Retrieve batch exports runs logs

    Path parameters

    • batch_export_id
      string

      The BatchExport this run belongs to.

    • id
      string

      A UUID string identifying this batch export run.

    • project_id
      string

      Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

    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/

    Response

    Status 200 No response body

    Create batch exports runs retry

    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

      The BatchExport this run belongs to.

    • id
      string

      A UUID string identifying this batch export run.

    • project_id
      string

      Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

    Request parameters

    • status

      The status of this run.

      • Cancelled - Cancelled
      • Completed - Completed
      • ContinuedAsNew - Continued As New
      • Failed - Failed
      • FailedRetryable - Failed Retryable
      • Terminated - Terminated
      • TimedOut - Timedout
      • Running - Running
      • Starting - Starting
    • records_completed
      integer

      The number of records that have been exported.

    • latest_error
      string

      The latest error that occurred during this run.

    • data_interval_start
      string

      The start of the data interval.

    • data_interval_end
      string

      The end of the data interval.

    • cursor
      string

      An opaque cursor that may be used to resume.

    • finished_at
      string

      The timestamp at which this BatchExportRun finished, successfully or not.

    • records_total_count
      integer

      The total count of records that should be exported in this BatchExportRun.

    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"

    Response

    Status 200 No response body

    Retrieve batch exports retrieve

    Required API key scopes

    batch_export:read

    Path parameters

    • id
      string

      A UUID string identifying this batch export.

    • project_id
      string

      Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

    Response


    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/

    Response

    Status 200
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "team_id": 0,
      "name": "string",
      "model": "events",
      "destination": {
        "type": "S3",
        "config": null
      },
      "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,
          "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
        }
      ],
      "hogql_query": "string",
      "schema": null
    }

    Update batch exports update

    Required API key scopes

    batch_export:write

    Path parameters

    • id
      string

      A UUID string identifying this batch export.

    • project_id
      string

      Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

    Request parameters

    • name
      string

      A human-readable name for this BatchExport.

    • model

      Which model this BatchExport is exporting.

      • events - Events
      • persons - Persons
    • destination
    • interval
    • paused
      boolean

      Whether this BatchExport is paused or not.

    • last_paused_at
      string

      The timestamp at which this BatchExport was last paused.

    • start_at
      string

      Time before which any Batch Export runs won't be triggered.

    • end_at
      string

      Time after which any Batch Export runs won't be triggered.

    • hogql_query
      string

    Response


    Request

    PATCH /api/projects/:project_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/projects/:project_id/batch_exports/:id/\
    	-d team_id="integer"

    Response

    Status 200
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "team_id": 0,
      "name": "string",
      "model": "events",
      "destination": {
        "type": "S3",
        "config": null
      },
      "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,
          "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
        }
      ],
      "hogql_query": "string",
      "schema": null
    }
    Next page →

    Questions?

    Was this page useful?