v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Social Referrals - Desktop

Returns the leading social networks sending traffic to a domain as well as traffic share per social network and number of social visits.

get/{domain_name}/traffic-sources/social

Path parameters

domain_namestring required

Enter website of interest, without 'www.' or brackets {}.

Query parameters

api_keystring required

Your Similarweb API key.

start_datestring

Start month (format: YYYY-MM)

end_datestring

End month (format: YYYY-MM)

countrystring required

Country filter, as a 2-letter ISO country code, or "world" for worldwide. To see the country filters you have access to, please refer to the Check Capabilities endpoint.

main_domain_onlystring

[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').

formatstring

[optional] Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'.

limitstring

[optional] Select the number of results that are returned. Default = 100.

offsetstring

[optional] Specify an offset from where to start returning data.

sortstring

[optional] The metric you'd like the results to be ordered by.

ascstring

[optional] The order of results. Enter "true" for ascending, or "false" for descending.

Response

200

visitsinteger

Example response

{
  "meta": {
    "query": {
      "limit": 100
    },
    "request": {
      "format": "json",
      "domain": "cnn.com",
      "start_date": "2023-01-01",
      "end_date": "2023-03-31",
      "country": "us"
    },
    "status": "Success",
    "last_updated": "2023-05-31"
  },
  "social": [
    {
      "page": "twitter.com",
      "share": 0.3308073990164531,
      "change": 0.1948473907616189
    }
  ],
  "visits": 11723719
}