Brandwatch Developer Hub

Welcome to the Brandwatch developer hub. You'll find comprehensive guides and API documentation to help you start working with Brandwatch as quickly as possible!

Get Started    

Analysis Results

Retrieve the status of the analysis request and the results.

Take the resultId from your analysis request and retrieve the results:

curl -X GET "https://api.brandwatch.com/analysis/527434743"

Here is an example response:

{
  "resultId": 527434743,
  "status": "DONE",
  "analysis": {
    "volume": {
      "TWITTER": 100
    },
    "sentiment": {
      "positive": {
        "proportion": 0.5,
        "count": 50
      },
      "negative": {
        "proportion": 0.3,
        "count": 30
      },
      "neutral": {
        "proportion": 0.2,
        "count": 20
      }
    },
    "location": {
      "totalVolume": 6490,
      "data": [
        {
          "info": {
            "id": "USA.WV",
            "name": "West Virginia",
            "country": "USA",
            "state": "WV"
          },
          "volume": 6490,
          "perMillion": 2.698335774427764
        }
      ]
    }
  },
  "request": {
    "analysis": ["volume", "sentiment", "location"],
    "startDate": "2014-01-01T00:00:00Z",
    "endDate": "2014-01-02T00:00:00Z",
    "sources": ["TWITTER"],
    "keywords": "(foo AND bar) OR (foo AND (\"escaped quotes\"OR baz)",
    "languages": {"type": "include","values": ["en", "fr"]},
    "locations": {"type": "exclude","values": ["DEU","ESP"]}
  }
}

Updated about a month ago


What's Next

You can also retrieve your usage information

Analysis Usage

Analysis Results


Retrieve the status of the analysis request and the results.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.