Batch

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

Endpoints

    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/
    DELETE/api/projects/:project_id/batch_exports/:id/
    POST/api/projects/:project_id/batch_exports/:id/backfill/
    GET/api/projects/:project_id/batch_exports/:id/logs/
    POST/api/projects/:project_id/batch_exports/:id/pause/
    POST/api/projects/:project_id/batch_exports/:id/run_test_step/
    POST/api/projects/:project_id/batch_exports/:id/unpause/
    POST/api/projects/:project_id/batch_exports/run_test_step_new/
    GET/api/projects/:project_id/batch_exports/test/

    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

    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

    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/.

    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/.

    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/.

    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

    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,
    "bytes_exported": -9223372036854776000,
    "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f",
    "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
    }
    ],
    "hogql_query": "string",
    "schema": null,
    "filters": 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/.

    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,
    "bytes_exported": -9223372036854776000,
    "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f",
    "backfill": "4f806519-f4aa-4807-bea5-95595ab1adf0"
    }
    ],
    "hogql_query": "string",
    "schema": null,
    "filters": null
    }

    Delete batch exports destroy

    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/.

    Response

    Status 204 No response body

    Create batch exports backfill create

    Trigger a backfill for a BatchExport.

    Note: This endpoint is deprecated. Please use POST /batch_exports/<id>/backfills/ instead.

    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/.

    Response

    Status 200 No response body

    Retrieve batch exports logs retrieve

    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

    Status 200 No response body

    Create batch exports pause create

    Pause a BatchExport.

    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/.

    Response

    Status 200 No response body

    Create batch exports run test step create

    Required API key scopes

    INTERNAL

    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

    Status 200 No response body

    Create batch exports unpause create

    Unpause a BatchExport.

    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/.

    Response

    Status 200 No response body

    Create batch exports run test step new create

    Required API key scopes

    INTERNAL

    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/.

    Response

    Status 200 No response body

    Retrieve batch exports test retrieve

    Required API key scopes

    INTERNAL

    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/.

    Response

    Status 200 No response body

    Community questions

    Questions about this page? or post a community question.