Data-API
The Data-API allows downloading raw data from the system. The Data-API can be found at endpoint
https://www.consentmanager.net/api/data.phpFetch data
In order to fetch the data of your CMPs please send a HTTP GET to the Data-API with the following parameters:
|
Parameter |
Description |
Example |
|
key |
Authentication Key |
jf892rt |
|
from |
Starting date |
1983-07-15 |
|
to |
End date |
2018-08-02 |
|
type |
Data type: · 1 = CMP report · 2 = Pubvendors report (no longer supported) · 3 = Crawler report · 4 = Consent log · 5 = CMP List · 6 = Design List · 7 = (Cookie) Domain List · 8 = Textversions · 9 = Custom vendor List · 10 = Custom purpose List · 11 = OS List · 12 = Browser List · 13 = Device List · 14 = Consent Type List · 15 = Last crawl IDs · 16 = (CMP delivery) Domain List · 17 = Subaccounts · 18 = Changelog · 19 = Consent log |
1 |
|
output |
csv or json |
json |
|
all |
0 or 1. Only valid for type=9 |
1 |
Result
The API will return the following object:
{
"status":"created", //status, always “created”
"message": "Data report created", //status message
"data": "…" //data payload as csv or json format
}Important: Please note, that the output format of the data payload can change from time to time (e.g. new columns being added, columns being removed, columns being changed). When designing your software, please take the necessary steps in order to detect changes in the data structure.
Examples
CMP report (type=1)
{
"status":"created",
"message":"Data report created",
"data": [
{
"cmpID":"3",
"designID":"13",
"country":"DE",
"date":"2019-05-27",
"hour":"23",
"urlID":"123",
"osID":"2",
"uaID":"4",
"deviceID":"2",
"pageView":"3",
"consentView":"0",
"consentAccept":"0",
"consentReject":"0",
...
}, ...
]
} Pubvendors report (type=2)
No longer supported.
Crawler report (type=3)
{
"status":"created",
"message":"Data report created",
"data":[
{"cmpID":"4",
"date":"2019-05-22",
"hour":"21",
"crawls":"8",
"cookiesFound":"564",
"cookiesNew":"10",
"domainsFound":"431",
"domainsNew":"1"
}, ...
]
}Consent log (type=4)
No longer supported. Use type=19 instead.
CMP List (type=5)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"3",
"name":"My CMP",
"status":"1"
}, ...
]
}Design List (type=6)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"1",
"name":"[Default]\/Bottom right",
"status":"1",
"defaultDesign":"1"
}, ...
]
} (Cookie) Domain List (type=7)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"1",
"domain":"example.com"
}, ...
]
} Textversions (type=8)
Note: The API will give the default texts for all languages as id=0.
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"design":0,
"date":null,
"lang":"EN",
"jsonText":
{
"cc":"en",
"load":"Loading",
"hl":"We value your privacy!",
"txt":"...",...
}
}, ...
]
}Custom vendor List (type=9)
Note: If parameter &all=1 is set, the API will report all custom and system vendors that are created. If the parameter is not set or set to 0 (zero), the API will only report vendors that are currently in use for any of your CMP.
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"c24",
"cmp":"3",
"name":"Google Ads",
"link":"https:\/\/policies.google.com\/privacy?hl=en&gl=ZZ",
"logo":"\/delivery\/icons_c24.ico"
}, ...
]
}Custom purpose List (type=10)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"1",
"cmp":"3",
"name":"My Purpose",
"description":"..."
}, ...
]
}OS List (type=11)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"name":"unknown"
},
{
"id":2,
"name":"Windows"
}, ...
]
}Browser List (type=12)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"name":"unknown"
},
{
"id":16,
"name":"Google Chrome"
}, ...
]
}Device List (type=13)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"name":"unknown"
},
{
"id":2,
"name":"Desktop"
},...
]
}Consent Type List (type=14)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":0,
"name":"unknown"
},
{
"id":1,
"name":"Button click: Accept all"
}, ...
]
}Last crawl IDs (type=15)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"23380",
"url":"https:\/\/www....",
"startDate":"2019-05-25 21:04:22",
"risk":"100"
}, ...
]
}(CMP delivery) Domain List (type=16)
Please use parameter &domainid=X in order to query a specific domain ID. Otherwise the list will output the IDs that have been used at this date range (e.g. today).
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"1",
"domain":"example.com"
}, ...
]
} Subaccounts (type=17)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"3",
"login":"...",
"mail":"...",
"rights":"cmp;designs;texts;...",
"restrictCMP":"0",
"allowedCMP":"3;4",
"status":"1",
"lastLogin":"2019-07-27 17:32:53"
}, ...
]
}Changelog (type=18)
{
"status":"created",
"message":"Data report created",
"data":[
{
"id":"820",
"datatype":"designs",
"changetype":"1",
"itemID":"11",
"userID":"1",
"subaccountID":"-1",
"accountID":"0",
"changedate":"2019-07-27 18:36:40",
"oldData":{...},
"newData":{...}
}, ...
]
}Consent log (type=19)
This type can be used in order to retrive the consent log (protocol) for an account. Note: Protocols are send to archive after 7 days and can no longer be downloaded via the API.
