Documentation / SDK v1

Settings

Read SDK-related agency settings via /sdk/v1.

settings · json
{
  "success": true,
  "data": {
    "preferredCurrency": "USD",
    "tiktokScrapeLocationEnabled": false,
    "tiktokScrapeCountryOptions": []
  }
}
All documentation

All endpoints below require:

  • X-Application-Id
  • X-Api-Key

GET /sdk/v1/settings

Get SDK-related agency settings.

Response

{
  "success": true,
  "data": {
    "preferredCurrency": "USD",
    "tiktokScrapeLocationEnabled": false,
    "tiktokScrapeCountryOptions": []
  }
}

When Grade enables campaign scraping locations for your agency, tiktokScrapeLocationEnabled is true and tiktokScrapeCountryOptions contains the supported countries as { "value": "VN", "label": "Vietnam" } entries. Use these values for tiktokScrapeCountryCode when creating or updating a campaign. The setting is read-only here; Grade controls agency access.

Describe your program.

Grade turns it into a program it can track and pay.