API

The methods detailed in this page are only applied to the GDPR process. We do not support CCPA through API for now.
By adding device IDs to your app’s Privacy Settings, Chartboost will stop collecting personal data from those devices for the app you specify within your account.
The API is for advanced users only! We recommend using the dashboard or CSV upload when possible. Each API request requires your user signature and user ID, which can be found at https://dashboard.chartboost.com/tools/api. You can attach these either as query parameters or as cookies. In the examples below, we use query parameters. You will also need an app_id for the specific app you want to restrict tracking on.

Get Blocked Device IDs

Request: 
curl -X GET -G \
  'https://dashapi.chartboost.com/v3/apps/[Your app_id here]/gdpr_do_not_track' \
  -d user_id=[Your user_id here] \
  -d user_signature=[Your user_signature here]
Response: 
{
  "code": 200,
  "response": {
    "data": [
    "68753A44-4D6F-1226-9C60-0050E4C00067",
    "68753A44-4D6F-1226-9C60-0050E4C00068",
    "68753A44-4D6F-1226-9C60-0050E4C00069"
    ],
    "meta": {
      "count": 3
    }
  },
  "time": 1526591011
}
Query parameter:
Key Type Info
meta_only bool Returns only the meta field of the response if set to true. Default: false

Blocking a Device ID

Request: 
curl -X PATCH \

'https://dashapi.chartboost.com/v3/apps/[Your app_id here]?user_id=[Your user_id here]&user_signature=[Your user_signature here]' \
  -d '{
      "gdpr_do_not_track": ["68753A44-4D6F-1226-9C60-0050E4C00070"]
}'
Response: 
{
    "code": 200,
    "response": {
        ...
        "gdpr_do_not_track": {
            "meta": {
                "count": 4
            }
        },
        ...
    },
    "time": 1526591755
}

Unblocking a Device ID

Request: 
curl -X DELETE -G \
  'https://dashapi.chartboost.com/v3/apps/<[Your app_id here]/gdpr_do_not_track/[Your device_id here]' \
  -d user_id=[Your user_id here] \
  -d user_signature=[Your user_signature here]
Response: 
{
  "code": 200,
  "response": "OK",
  "time": 1526592418
}