Use this API to create a bulk export based on the specified criteria.

🗒 Things to Know

• COOKIE_RECEIPTS exports are currently under Public Preview. Please contact OneTrust Support to request early access before running the export.
• All historic data is not available by default. COOKIE_RECEIPTS exports will become available once the feature is enabled. CONSENT_RECEIPTS exports are available from the OneTrust 202407.1.0 release or earlier if you had requested the feature while it was in preview.

Usage Guidelines

• Bulk Export Limits & Lifecycle:
  • Each account is limited to 20 bulk exports per month. If you cancel a bulk export before it completes, it will not be counted towards this limit. To increase your export limit, contact OneTrust Support.
  • The status of a bulk export will automatically change to Expired 10 days after its creation.
• Data Volume & File Constraints:
  • The maximum limit allowed is 1 million records, which is equivalent to approximately 8MB for COOKIE_RECEIPTS and CONSENT_RECEIPTS exports.
  • For bulk exports less than 1 million records, we recommend using a report to pull the list. As it cannot be guaranteed that the bulk export reaches this maximum, the results will be split across multiple files up to 1 million records.
• Date & Time Constraints:
  • The timespan for the endDate - startDate is limited to 180 days when the exportType is CONSENT_RECEIPTS OR COOKIE_RECEIPTS and 30 days when it's ANONYMOUS_RECEIPTS.
  • The endDate can be as recent as yesterday, but cannot be the current day.
  • If a value is not provided for the dateType parameter in DATA_SUBJECTS exports, this value will be set to CREATED_DATE by default.
• Filtering:
  • CONSENT_RECEIPTS and COOKIE_RECEIPTS only support filtering based on either collectionPointGuid or purposeGuid. Both cannot be used at the same time.
  • Bulk export filters are case-sensitive.
• Additional Information:
  • For DATA_SUBJECTS exports, only data subjects with a recorded consent transaction will be included.
  • For DATA_SUBJECTS_BULK_ACTIONS exports, select CSV as the exportFormat for a compatible output with the Consent data subjects bulk actions import template in the OneTrust Platform. Once imported, related receipts will be deleted.

{
  "exportType": "CONSENT_RECEIPTS",
  "startDate": "2023-07-01",
  "endDate": "2023-12-01",
  "params": [
    {
      "name": "collectionPointGuid",
      "values": [
        "af01cad5-a39d-4585-9ee1-2062b1426bdd"
      ]
    }
  ]
}

{
  "exportType": "COOKIE_RECEIPTS",
  "startDate": "2023-11-01",
  "endDate": "2023-12-01",
  "params": [
    {
      "name": "purposeGuid",
      "values": [
        "af01cad5-a39d-4585-9ee1-2062b1426bdd"
      ]
    }
  ]
}

{
    "exportType": "DATA_SUBJECTS",
    "startDate": "2024-01-01",
    "endDate": "2024-06-01",
    "params": [
        {
            "name": "lastTransactionCollectionPointId",
            "values": [
                "c0431f94-664b-431e-bff3-3b341571c2af"
            ]
        },
        {
            "name": "purposeId",
            "values": [
                "514780d1-7797-4952-84e7-d6c70b018fed",
                "fb1ec920-68cd-4c9a-99da-77b21bd5b9d5",
                "55ede8d8-0aab-40b8-a6b7-6c5221b62aa7"
            ]
        },
        {
            "name": "status",
            "values": [
                "ACTIVE"
            ]
        },
        {
            "name": "dataElementName",
            "values":[
                "FirstName"
            ]
        },
                {
            "name": "dataElementValue",
            "values":[
                "George"
            ]
        }
    ]
}

{
  "name": "Monthly Consent Report - Q2 2023",
  "exportType": "CONSENT_RECEIPTS",
  "startDate": "2023-07-01",
  "endDate": "2023-12-01",
  "exportFormat": "CSV",
  "params": [
    {
      "values": [
        "a7c95f18-c0d6-4a19-8e7a-c2de93e58a52"
      ]
    }
  ]
}

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