Top Sites

If you are using the new Consumer Research product, you should be using v2.0 of our documentation. Due to deprecated mention fields found in the updated version of the Mention Field Definitions page, you will receive a new response when retrieving top sites data. This new response is shown on the updated Top Sites page.

You can receive an aggregated breakdown of the top sites that your Mentions come from by using the following API call.

It supports all of our 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 Topics.	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/128287432/data/volume/topsites/queries?queryId=1273272814&startDate=2017-11-11&endDate=2017-11-18'

The results will look like the following:

{
    "aggregate": "volume",
    "dimension1": "topsites",
    "dimension2": "queries",
    "results": [
        {
            "id": "www.instagram.com",
            "name": "www.instagram.com",
            "values": [
                {
                    "id": 1273272814,
                    "name": "Battenwear",
                    "value": null,
                    "data": {}
                }
            ],
            "data": {
                "domain": "www.instagram.com",
                "pagesPerVisit": 0,
                "averageVisits": 0,
                "monthlyVisitors": 0,
                "percentFemaleVisitors": 0,
                "percentMaleVisitors": 0,
                "volume": 27,
                "countryCode": "it",
                "countryName": "Italy",
                "mozRank": 8.96,
                "backlinks": 4574323,
                "averageDurationOfVisit": 0,
                "impact": 56,
                "impactRelevancy": 27,
                "impactAmplification": 95,
                "impactReach": 31,
                "sentiment": {
                    "positive": 1,
                    "negative": 0,
                    "neutral": 26
                },
                "authorName": "civiliancouture",
                "authorVolume": 5,
                "authorGender": null,
                "authorAccountType": null,
                "authorInterest": null,
                "authorProfessions": null,
                "authorReach": 0
            }
        },
        {
            "id": "twitter.com",
            "name": "twitter.com",
            "values": [
                {
                    "id": 1273272814,
                    "name": "Battenwear",
                    "value": null,
                    "data": {}
                }
            ],
            "data": {
                "domain": "twitter.com",
                "pagesPerVisit": 22,
                "averageVisits": 6,
                "monthlyVisitors": 6000000000,
                "percentFemaleVisitors": 46,
                "percentMaleVisitors": 54,
                "volume": 6,
                "countryCode": "uk",
                "countryName": "United Kingdom",
                "mozRank": 9.6,
                "backlinks": 49850734,
                "averageDurationOfVisit": 20,
                "impact": 40,
                "impactRelevancy": 6,
                "impactAmplification": 30,
                "impactReach": 73,
                "sentiment": {
                    "positive": 0,
                    "negative": 0,
                    "neutral": 6
                },
                "authorName": "grants1856",
                "authorVolume": 2,
                "authorGender": null,
                "authorAccountType": "individual",
                "authorInterest": null,
                "authorProfessions": null,
                "authorReach": 0
            }
        },
        {
            "id": "www.reddit.com",
            "name": "www.reddit.com",
            "values": [
                {
                    "id": 1273272814,
                    "name": "Battenwear",
                    "value": null,
                    "data": {}
                }
            ],
            "data": {
                "domain": "www.reddit.com",
                "pagesPerVisit": 0,
                "averageVisits": 0,
                "monthlyVisitors": 0,
                "percentFemaleVisitors": 0,
                "percentMaleVisitors": 0,
                "volume": 4,
                "countryCode": "us",
                "countryName": "United States",
                "mozRank": 0,
                "backlinks": 0,
                "averageDurationOfVisit": 0,
                "impact": 12,
                "impactRelevancy": 4,
                "impactAmplification": 0,
                "impactReach": 31,
                "sentiment": {
                    "positive": 0,
                    "negative": 0,
                    "neutral": 4
                },
                "authorName": "Pyrerift",
                "authorVolume": 2,
                "authorGender": null,
                "authorAccountType": null,
                "authorInterest": null,
                "authorProfessions": null,
                "authorReach": 0
            }
        },
        {
            "id": "www.facebook.com",
            "name": "www.facebook.com",
            "values": [
                {
                    "id": 1273272814,
                    "name": "Battenwear",
                    "value": null,
                    "data": {}
                }
            ],
            "data": {
                "domain": "www.facebook.com",
                "pagesPerVisit": 31,
                "averageVisits": 7,
                "monthlyVisitors": 910000000000,
                "percentFemaleVisitors": 50,
                "percentMaleVisitors": 50,
                "volume": 1,
                "countryCode": "us",
                "countryName": "United States",
                "mozRank": 9.55,
                "backlinks": 33745067,
                "averageDurationOfVisit": 25,
                "impact": 9,
                "impactRelevancy": 1,
                "impactAmplification": 0,
                "impactReach": 25,
                "sentiment": {
                    "positive": 0,
                    "negative": 0,
                    "neutral": 1
                },
                "authorName": "Darcey Alexander",
                "authorVolume": 1,
                "authorGender": null,
                "authorAccountType": null,
                "authorInterest": null,
                "authorProfessions": null,
                "authorReach": 0
            }
        }
    ]
}