v1

latestOpenAPI 3.1.02026-07-2414103.5 MB

Outgoing Referrals - Mobile Web

Returns traffic share and change of all outgoing mobile referral links for a given domain, as well as the number of outgoing mobile visits.

get/{domain_name}/traffic-sources/mobileweb-outgoing-referrals

Path parameters

domain_namestring required

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

Query parameters

api_keystring required

Your Similarweb API key.

start_datestring required

Start month (format: YYYY-MM)

end_datestring required

Start 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

global_rankinginteger

categorystring

category_rankinginteger

Example response

{
  "meta": {
    "query": {
      "limit": 100
    },
    "request": {
      "format": "json",
      "domain": "cnn.com",
      "start_date": "2023-02-01",
      "end_date": "2023-03-31",
      "country": "us"
    },
    "status": "Success",
    "last_updated": "2023-05-31"
  },
  "referrals": [
    {
      "share": 0.24218175973902806,
      "domain": "paid.outbrain.com",
      "change": -0.004089477040863748
    }
  ],
  "visits": 46800395,
  "global_ranking": 88,
  "category": "News_and_Media",
  "category_ranking": 13
}