Cookie details can be extracted through the Cookiebot data API by calling this URL:
https://consent.cookiebot.com/api/v1/{apikey}/json/domaingroup/{serial}/domain/{domain}/({domainpath}/)consent/stats?startdate={startdate}&enddate={enddate}
{apikey}
The secret API key for your Cookiebot account is available under Settings on the Your scripts tab in the Cookiebot Manager.
{serial}
Domain group ID (available under the menu point 'Settings' and the tab 'Your scripts')
{domain}
Domain name as registered under your Cookiebot account
{domainpath}
Optional. Only used if a domain path is configured
{startdate}
The start date in YYYYMMDD format
{enddate}
The end date in YYYYMMDD format
Please note:
Data cannot retrieved beyond 12 months previous to the current date.
A successful request will return a response with the following data:
{
"domain": "www.domain.com",
"urlpath": "/",
"utcstartdate": "YYYY-MM-DDT00:00:00.0000000Z",
"utcenddate": "YYYY-MM-DDT23:59:59.9990000Z",
"consentstat": {
"consentday": {
"Date": "YYYY-MM-DDT00:00:00",
"OptIn": "0",
"OptOut": "0",
"OptInImplied": "0",
"OptInStrict": "0",
"TypeOptInPref": "0",
"TypeOptInStat": "0",
"TypeOptInMark": "0",
"BulkOptInImplied": "0",
"BulkOptInStrict": "0",
"Countries": {
"Country": [
{
"Code": "aa",
"Count": "0"
}
]
}
}
}
}
- Domain
- URL path (if applied)
- Start date (UTC)
- End date (UTC)
- Consent stats
For each day:
- Date
- Number of opt-ins
- Number of opt-outs
- Number of implied opt-ins 1
- Number of strict opt-ins 2
- Number of opt-ins in the preferences category
- Number of opt-ins in the statistics category
- Number of opt-ins in the marketing category
- Number of implied bulk consent opt-ins 3
- Number of strict bulk consent opt-ins 4
- Countries
For each country:
- Country code (ISO 3166-1 alpha-2)
- Number of consents
The data extracted by making this call is the same data that can be found under the Consents section in the Cookiebot Manager and is also available for download from your account: Where can I access the consent log for documentation of user consents? – Cookiebot Support
1
Consent submitted by ignoring the banner and interacting with the page when having the "Implied consent" method enabled in the Manager. This behavior is not active by default.
Implied consent can also be triggered if the banner is configured to only ask for consent in specific regions. Visitors outside of these regions will automatically be opted-in.
2
Consent submitted by clicking on one of the buttons on the banner.
This is often referred to as Active or Explicit consent and is the default consent method.
3
Consent submitted by previously actively submitting consent, by clicking on one of the buttons on the banner on another domain within the same domain group where Bulk Consent is enabled.
For more information about Bulk Consent please review this article
4
Consent submitted by ignoring the banner and interacting with the page when having the "Implied consent" method enabled in the Manager on another domain within the same domain group where Bulk Consent is enabled.
For more information about Bulk Consent please review this article
Comments
6 comments
That's great, very helpful indeed. Would you add some information about what a "strict","implied", and "bulk" opt-in is?
I was assuming that a strict optin includes the consent to all categories, however in my stats the number of strict optins is higher than the optins to the separate categories pref/mark/stat.
Also it would be good to know at which time the daily accumulated data is processed . In other words at what time of day should i schedule the import of yesterday's data?
Thanks,
Ulrich
Hi Ulrich Babiak,
Thank you for your feedback. It's easy for us to forget that certain terms probably don't make sense to most of our users.
"strict" and "implied" refer to consent methods, not whether full or partial consent was given.
I've tried to explain these concepts by adding annotations, do let me know if it's still unclear though.
Thanks for the clarification. OK, so there is no explicit count of users that have consented to all three categories pref/stat/mark.
One last thing, important for the interpretation of the stats - these counters are counting only users who interact with the banner, not users that have given their consent some time earlier and thus are not seeing the banner - right?
This question had been asked a while ago here:
https://support.cookiebot.com/hc/en-us/community/posts/4403152118418-Consents-Understanding-the-statistics
Since the data API is not documented, I wonder if I hand out the API key to a contractor (for data analysis) , would they be able to change settings ? Or is the API just enabled for data retrieval / read access?
Hi Ulrich Babiak,
The API is only for retrieving data. You can't edit or delete data with it.
The consent logs contain no personal information, so in that regard you can safely hand out the API key to a partner, but we generally don't recommend sharing your personal API key or making it publicly available.
Perfect, thanks!
Please sign in to leave a comment.