Top Shared URLs

You can receive a breakdown of the top shared URLs by using the following API call.

It supports all of our Filters.

Required Parameters

ParameterDefinitionAccepted Values
queryId / queryGroupIdThe ID of the Query or Query Group that contains the Mentions that you'd like to see.int
(Learn how to retrieve your Query ID or Query Group ID
startDateThe beginning of the date range that contains the Mentions"YYYY-MM-DD'T'hh:mm:ss:xx.xx+xxxx"
endDateThe end of the date range that contains the Mentions"YYYY-MM-DD'T'hh:mm:ss:xx.xx+xxxx"

Optional Parameters

ParameterDefinitionAccepted Values
limitThe number of shared URLs you'd like to retrieveint 0-1000

Example Call

curl -X GET 'https://api.brandwatch.com/projects/1998283571/data/urls?startDate=2020-03-06&endDate=2021-03-06&queryId=2000031816'

The results will look like the following:

{
    "results": [
        {
            "label": null,
            "volume": 393,
            "tweets": 0,
            "retweets": 393,
            "impressions": 410503,
            "name": "https://www.screendaily.com/news/hollywood-stays-on-track-with-uk-shoots-despite-tighter-covid-quarantine-rules/5156546.article"
        },
        {
            "label": null,
            "volume": 108,
            "tweets": 2,
            "retweets": 106,
            "impressions": 2648087,
            "name": "https://variety.com/2020/film/news/the-batman-delays-release-1234793625/"
        },
        {
            "label": null,
            "volume": 26,
            "tweets": 1,
            "retweets": 25,
            "impressions": 201578,
            "name": "https://screenrant.com/flash-movie-new-costume-batman-creation-concept-art/?utm_content=buffer121ee&utm_medium=Social-Distribution&utm_source=SR-TW&utm_campaign=SR-TW"
        },
        {
            "label": null,
            "volume": 21,
            "tweets": 1,
            "retweets": 20,
            "impressions": 49393,
            "name": "https://thedirect.com/article/the-flash-michael-keaton-in-talks-to-play-a-key-role-in-1989-earth-section-of-flashpoint-film"
        },
        {
            "label": null,
            "volume": 20,
            "tweets": 1,
            "retweets": 19,
            "impressions": 589607,
            "name": "https://www.bbc.co.uk/weather/features/53278830"
        },
        {
            "label": null,
            "volume": 16,
            "tweets": 1,
            "retweets": 15,
            "impressions": 69007,
            "name": "https://www.ellipsiszine.com/ellipsis-flash-collection-competition/"
        },
        {
            "label": null,
            "volume": 10,
            "tweets": 1,
            "retweets": 9,
            "impressions": 195840,
            "name": "https://www.theverge.com/2020/3/6/21167191/boosted-board-layoffs-urban-transportation-bikes-scooters?utm_campaign=backlon&utm_content=chorus&utm_medium=social&utm_source=twitter"
        },
        {
            "label": null,
            "volume": 9,
            "tweets": 1,
            "retweets": 8,
            "impressions": 19206,
            "name": "http://www.ellipsiszine.com/ellipsis-flash-collection-competition/"
        },
        {
            "label": null,
            "volume": 9,
            "tweets": 0,
            "retweets": 9,
            "impressions": 29850,
            "name": "https://www.instagram.com/riprocketpix/"
        },
        {
            "label": null,
            "volume": 9,
            "tweets": 8,
            "retweets": 1,
            "impressions": 15373,
            "name": "https://www.theverge.com/2020/3/6/21167191/boosted-board-layoffs-urban-transportation-bikes-scooters?utm_source=dlvr.it&utm_medium=twitter"
        }
    ],
    "orderBy": "volume",
    "orderDirection": "desc"
}

You may also choose how many sites are shown and the order in which they are sorted by using the limit and orderBy parameters, like so:

curl -X GET 'https://api.brandwatch.com/projects/1998283571/data/urls?startDate=2020-03-06&endDate=2021-03-06&queryId=2000031816&limit=10&orderBy=volume'