Data Retrieval

If you are using the new Consumer Research product, you should be using v2.0 of our documentation. There have been a few aggregates and dimensions which have been deprecated. These changes can be found in the updated version of the Chart aggregates and dimensions page. Furthermore, due to deprecated mention fields documented in the updated version of the Mention Field Defintions page, you will receive a new response when retrieving data on top sites, top authors and top tweeters.

Beyond simply retrieving a list of Mentions, it's also possible to aggregate data about a set of Mentions and return that via our API. This is the same data that would feed Dashboards in the Brandwatch Analytics UI.

For example, you can see the topics that are trending in your data set, the daily sentiment breakdown of your Mentions, or just simply the total volume of conversation in the past x amount of time.

Learn more about the API calls for:

Note: Data Retrieval calls can be filtered so that you can access specific parts of your data. To learn more about this, see Filters.