Referrals - Desktop

get

https://api.similarweb.com/v4/website/{domain_name}/traffic-sources/referrals

Returns the referring websites for a given domain, traffic share, change per referrer, and # of total referral visits.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

domain_name

string

required

Defaults to amazon.com

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

Query Params

api_key

string

required

Defaults to Add_Your_API_KEY

Your Similarweb API key.

start_date

string

Defaults to 2023-01

Start month (format: YYYY-MM)

end_date

string

Defaults to 2023-03

End month (format: YYYY-MM)

country

string

required

Defaults to us

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_only

string

Defaults to false

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

format

string

Defaults to json

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

limit

string

Defaults to 100

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

offset

string

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

sort

string

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

asc

string

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

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200