These docs are for v1.0. Click to read the latest docs for v2.0.

Retrieving Location Lists

Getting lists of Locations that have been saved in Brandwatch Analytics.

The following call will return all of the Location Lists in the Project with ID 398748937:
(Click here to learn how to get your Project ID)

curl -X GET https://api.brandwatch.com/projects/398748937/group/location/summary

The response will be like the following:

{
  "resultsTotal": 1,
  "resultsPage": -1,
  "resultsPageSize": -1,
  "results": [
    {
      "id": 179865741,
      "name": "Top locations",
      "shared": "public",
      "sharedProjectIds": [
        398748937
      ],
      "locations": [
        {
          "id": "cn",
          "name": "People's Republic of China",
          "type": "country",
          "fullName": "People's Republic of China, Asia"
        },
        {
          "id": "jp",
          "name": "Japan",
          "type": "country",
          "fullName": "Japan, Asia"
        },
        {
          "id": "kr",
          "name": "Republic of Korea",
          "type": "country",
          "fullName": "Republic of Korea, Asia"
        },
        {
          "id": "tw",
          "name": "Republic of China (Taiwan)",
          "type": "country",
          "fullName": "Republic of China (Taiwan), Asia"
        }
      ],
      "userName": "[email protected]",
      "userId": 179428706
    }
  ],
  "projects": [
    {
      "id": 398748937,
      "name": "Shopping trends",
      "description": "",
      "billableClientId": 39837783,
      "billableClientName": null,
      "timezone": "America/New_York",
      "billableClientIsPitch": false
    }
  ]
}