Twitter Insights

You can receive aggregated breakdowns of Twitter metadata via the four endpoints that power our Twitter Insights component.

  • Emoticons
  • Hashtags
  • Mentioned authors
  • Stories

These endpoints are very similar, and accept all of our usual Filters.

Required Parameters

Parameter

Definition

Accepted Values

queryId / queryGroupId

The ID of the Query or Query Group that contains the Mentions for which you'd like to see.

int
(Learn how to retrieve your Query ID or Query Group ID

startDate

The beginning of the date range that contains the Mentions.

"YYYY-MM-DD'T'hh:mm:ss:xx.xx+xxxx"

endDate

The end of the date range that contains the Mentions.

"YYYY-MM-DD'T'hh:mm:ss:xx.xx+xxxx"

Example Call

curl -X GET 'https://api.brandwatch.com/projects/397382923/data/hashtags?queryId=1834636622&startDate=2017-11-11&endDate=2017-11-18'

The result will look like the following:

{
    "results": [
        {
            "name": "#battenwear",
            "label": null,
            "volume": 27,
            "tweets": 27,
            "retweets": 0,
            "impressions": 0
        },
        {
            "name": "#menswear",
            "label": null,
            "volume": 6,
            "tweets": 6,
            "retweets": 0,
            "impressions": 0
        },
        {
            "name": "#outdoor",
            "label": null,
            "volume": 5,
            "tweets": 5,
            "retweets": 0,
            "impressions": 0
        },
        {
            "name": "#patagonia",
            "label": null,
            "volume": 5,
            "tweets": 5,
            "retweets": 0,
            "impressions": 0
        },
        {
            "name": "#fresh",
            "label": null,
            "volume": 4,
            "tweets": 4,
            "retweets": 0,
            "impressions": 0
        },
        {
            "name": "#freshstoretorino",
            "label": null,
            "volume": 4,
            "tweets": 4,
            "retweets": 0,
            "impressions": 0
        },
        {
            "name": "#sportswear",
            "label": null,
            "volume": 4,
            "tweets": 4,
            "retweets": 0,
            "impressions": 0
        },
        {
            "name": "#streetstyle",
            "label": null,
            "volume": 4,
            "tweets": 4,
            "retweets": 0,
            "impressions": 0
        },
        {
            "name": "#streetwear",
            "label": null,
            "volume": 4,
            "tweets": 4,
            "retweets": 0,
            "impressions": 0
        },
        {
            "name": "#torino",
            "label": null,
            "volume": 4,
            "tweets": 4,
            "retweets": 0,
            "impressions": 0
        }
    ],
    "orderBy": "volume",
    "orderDirection": "desc"
}

The following calls give you the emoticons, stories and mentioned authors respectively.

curl -X GET 'https://api.brandwatch.com/projects/397382923/data/emoticons?queryId=1834636622&startDate=2017-11-11&endDate=2017-11-18'
curl -X GET https://api.brandwatch.com/projects/397382923/data/urls?queryId=1834636622&startDate=2017-11-11&endDate=2017-11-18
curl -X GET 'https://api.brandwatch.com/projects/397382923/data/mentionedauthors?queryId=1834636622&startDate=2017-11-11&endDate=2017-11-18'