Get statistics
Get data from the consent dashboard (aggregated data)
getGet Statistics
get
https://api-internal.commander1.com/v2/{siteId}/privacy/statistics
This endpoint allows you to get the data from the consent dashboard on a specific date range
Request
Response
Request
Path Parameters
{siteId}
required
string
Account ID
example: '12345'
Query Parameters
token
required
string
Authentication token. Optional if the header "Authorization' parameter is used instead.
filter[begin_date]
required
string
example: '2021-04-30'
filter[end_date]
required
string
example: '2021-04-31'
Response
200: OK
Data successfully retrieved.
{"data": [{"type": "privacy/statistic","id": "1","attributes": {"nb_banner_views": 198,"nb_banner_clicks_button": 32,"nb_optin": 34,"nb_optin_all": 33,"nb_optin_all_on_click_banner": 23,"nb_banner_clicks_links_not_PC": 1,"nb_PC_views": 1,"nb_optin_all_on_browsing": 10,"optin_rate": 0.1717171717171717,"optout_rate": 0,"nb_optin_category_1": 35,"optin_rate_category_1": 0.17676767676767677,"nb_optin_category_2": 35,"optin_rate_category_2": 0.17676767676767677,"nb_optin_category_3": 35,"optin_rate_category_3": 0.17676767676767677,"nb_optin_category_4": 35,"optin_rate_category_4": 0.17676767676767677,"nb_optin_category_5": 14,"optin_rate_category_5": 0.0707070707070707,"nb_optin_category_10001": 7,"optin_rate_category_10001": 0.03535353535353535,"nb_optin_category_10003": 7,"optin_rate_category_10003": 0.03535353535353535,"nb_optin_category_10005": 7,"optin_rate_category_10005": 0.03535353535353535,"nb_optin_category_10007": 7,"optin_rate_category_10007": 0.03535353535353535,"nb_optin_category_10009": 7,"optin_rate_category_10009": 0.03535353535353535,"nb_optin_category_10011": 7,"optin_rate_category_10011": 0.03535353535353535,"nb_optin_category_10013": 7,"optin_rate_category_10013": 0.03535353535353535,"nb_optin_category_10015": 7,"optin_rate_category_10015": 0.03535353535353535,"nb_optin_category_10017": 7,"optin_rate_category_10017": 0.03535353535353535,"nb_optin_category_10019": 7,"optin_rate_category_10019": 0.03535353535353535,"nb_optin_category_13001": 7,"optin_rate_category_13001": 0.03535353535353535,"nb_optin_category_13003": 7,"optin_rate_category_13003": 0.03535353535353535}},{"type": "privacy/statistic","id": "20","attributes": {"nb_PC_views": 1,"optin_rate": 0,"optout_rate": 0}}]}
401: Unauthorized
Invalid token
{"errors": [{"status": 401,"title": "Unauthenticated.","detail": "The access token provided is expired, revoked, malformed, or invalid.","context": []}]}
For each API, you'll have to ask a token to your account manager or support team.