Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Bulk Export

Get Bulk Export Status

Use this API to retrieve the current status and progress of a bulk export.

🗒 Things to Know

  • The status of a bulk export will automatically change to Expired 10 days after its creation.
get/api/ot-insights/v1/bulk-export-jobs/{id}

Path parameters

idstring uuid required

The unique identifier for the bulk export.

The unique identifier for the bulk export.

Response

OK

runIdstring uuid

The unique identifier for the bulk export.

namestring

The name of the bulk export.

status'EXPORT_IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'CANCELLED'

The current status of the bulk export.

createdDatestring date-time

The date and time that the bulk export was initiated.

exportType'Consent Receipts' | 'Cookie Receipts' | 'Data Subjects'

The type of data to export.

fileFormat'csv' | 'json'

The file format of the bulk export.

completionDatestring date-time

The date and time that the bulk export was completed.

expiryDatestring date-time

The date and time that the bulk export file expires.

progressPercentagenumber double

The percent progress of completion for the bulk export.

availableCreditinteger

The number of remaining bulk exports for the account.

recordCountinteger

The total number of records included within the bulk export.

startDatestring date

The start of a date range used to filter results.

endDatestring date

The end of a date range used to filter results.

Example response

{
  "runId": "90f2241a-16d7-45e8-b913-1cb9951bb843",
  "name": "Bulk Export",
  "status": "EXPORT_IN_PROGRESS",
  "createdDate": "2024-11-24 22:20:30",
  "createdBy": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ],
    "optionBasedAttributeName": [
      {
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
      }
    ]
  },
  "exportType": "Data Subjects",
  "fileFormat": "csv",
  "completionDate": "2024-11-24 22:20:30",
  "expiryDate": "2024-11-24 22:20:30",
  "progressPercentage": 90.5,
  "availableCredit": 6,
  "recordCount": 1000000,
  "startDate": "2023-07-01",
  "endDate": "2023-12-01",
  "params": [
    {
      "name": "primaryIdentifierType",
      "values": [
        "email"
      ]
    }
  ]
}