Search results for "{{ search.query }}"

No results found for "{{search.query}}". 
View All Results

Retrieving Mentions

Listing the Mentions within your Query.

Required Parameters

There are three required parameters when retrieving Mentions:

Parameter
Definition
Accepted Values

queryId / queryGroupId

The ID of the Query or Query Group that contains the Mentions.

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"

Pagination

You can control the pagination by passing the following additional parameters. For more information on pagination, see the tutorial Paging through historical Mentions.

Parameter
Definition
Accepted Values

pageSize

The number of Mentions on each page of the response.

An integer from 1-5000

page

The page to retrieve, indexed from 0.

An integer, index starting at 0.

Ordering

You also have the option to control the ordering by passing additional parameters:

Parameter
Definition
Accepted Values

orderBy

The field you'd like to order the Mentions by.

"date" - the date of the mention (default)
"added" - the time the mention matched your query
"updated" - the time when the mention was last updated
"impact" - Brandwatch specific metric that tells you the potential impact of a mention

orderDirection

The direction to order the Mentions.

"desc" (descending) or "asc" (ascending)

Example Call

An example call for Mentions in the Project with ID 289733322 is below.
(Click here to learn how to get your Project ID)

curl -X GET https://api.brandwatch.com/projects/289733322/data/mentions?queryId=348973733&startDate=2016-05-01&endDate=2016-05-02&pageSize=1&page=0

The response will look like this:

{
  "resultsTotal": 99,
  "resultsPage": 0,
  "resultsPageSize": 1,
  "results": [
    {
      "accountType": null,
      "assignment": null,
      "author": "",
      "authorCity": null,
      "authorCityCode": null,
      "authorContinent": null,
      "authorContinentCode": null,
      "authorCountry": null,
      "authorCountryCode": null,
      "authorCounty": null,
      "authorCountyCode": null,
      "authorLocation": null,
      "authorState": null,
      "authorStateCode": null,
      "avatarUrl": null,
      "averageDurationOfVisit": 0,
      "averageVisits": 0,
      "backlinks": 19,
      "blogComments": 0,
      "categories": [],
      "categoryDetails": [],
      "checked": false,
      "city": null,
      "cityCode": null,
      "continent": Europe,
      "continentCode": "eu",
      "country": "United Kingdom",
      "countryCode": "uk",
      "county": null,
      "countyCode": null,
      "date": "2016-06-07T02:04:00.000+0000",
      "displayUrls": [],
      "domain": "bbc.co.uk",
      "engagement": 0,
      "expandedUrls": [],
      "facebookAuthorId": null,
      "facebookComments": 0,
      "facebookLikes": 0,
      "facebookRole": null,
      "facebookShares": 0,
      "facebookSubtype": null,
      "forumPosts": 0,
      "forumViews": 0,
      "fullname": null,
      "gender": "unknown",
      "id": 100057070129,
      "impact": 53,
      "importanceAmplification": 76,
      "importanceReach": 31,
      "impressions": 0,
      "influence": 0,
      "insightsHashtag": [],
      "insightsMentioned": [],
      "instagramCommentCount": 0,
      "instagramFollowerCount": 0,
      "instagramFollowingCount": 0,
      "instagramLikeCount": 0,
      "instagramPostCount": 0,
      "interest": [],
      "language": "en",
      "lastAssignmentDate": null,
      "latitude": 0,
      "locationName": null,
      "longitude": 0,
      "matchPositions": [],
      "mediaUrls": [],
      "monthlyVisitors": 0,
      "mozRank": 5.87,
      "noteIds": [],
      "outreach": 0,
      "pageType": "forum",
      "pagesPerVisit": 0,
      "percentFemaleVisitors": 0,
      "percentMaleVisitors": 0,
      "priority": null,
      "professions": [],
      "queryId": 348973733,
      "queryName": "Telecoms news",
      "reach": 0,
      "replyTo": null,
      "resourceId": 100057070129,
      "resourceType": "page",
      "retweetOf": null,
      "sentiment": "neutral",
      "shortUrls": [],
      "snippet": "... known for his boisterous presentations and love of social media, said: 'Get ready for a gratitude adjustment, America. This Un-carrier move is all about giving you a good thanking! No strings. No gotchas. Just...",
      "starred": false,
      "state": null,
      "stateCode": null,
      "status": null,
      "subtype": null,
      "tags": [],
      "threadAuthor": null,
      "threadCreated": null,
      "threadEntryType": null,
      "threadId": "0",
      "threadURL": null,
      "title": "T-Mobile US customers offered free shares - BBC News",
      "trackedLinkClicks": 0,
      "trackedLinks": null,
      "twitterAuthorId": null,
      "twitterFollowers": 0,
      "twitterFollowing": 0,
      "twitterPostCount": 0,
      "twitterReplyCount": 0,
      "twitterRetweets": 0,
      "twitterRole": null,
      "twitterVerified": false,
      "url": "http://www.bbc.co.uk/news/business-36466844",
      "wordCount": null
    }
  ],
  "maximumId": 100057070129,
  "maximumIdInResult": 100057070129,
  "startDate": "2016-05-01T00:00:00.000+0000",
  "endDate": "2016-05-02T00:00:00.000+0000"
}

For definitions of the returned fields, see Mention Field Definitions.

Encoding

The Analytics API will return data as it was found and does not apply any additional encoding or sanitization before returning it through the Mentions endpoint. It is your responsibility to make sure that it is formatted correctly for display in your own application.


Retrieving Mentions

Listing the Mentions within your Query.