post https://{hostname}/api/ot-insights/v1/bulk-export-jobs
Recipes
Bulk Export for Data Subjects, Consent Receipts, and Cookie Receipts
Open Recipe
Use this API to create a bulk export based on the specified criteria.
Things to Know
- For
COOKIE_RECEIPTSexports, please reach out to your OneTrust representative or production support before running.- Each account is limited to six bulk exports per month. If you cancel a bulk export before it completes, it will not be counted towards this limit.
- The timespan for endDate-startDate is limited to 6 months when the exportType is
CONSENT_RECEIPTSorDATA_SUBJECTSand 1 month when it'sCOOKIE_RECEIPTS.endDatecan be as recent as yesterday, but cannot be the current day.CONSENT_RECEIPTSandCOOKIE_RECEIPTSonly support filtering based oncollectionPointGuidorpurposeGuid. Both cannot be used at the same time.- For
DATA_SUBJECTSexports, only data subjects with a recorded consent transaction will be included.- If a value is not provided for the
dateTypeparameter inDATA_SUBJECTSexports, this will be set toCREATED_DATEby default.- The
statusof a bulk export will automatically change toExpired10 days after its creation.
{
"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"
]
}
]
}