Similarweb
App · 25 actions
Research website visits, engagement, rankings, geography and traffic channels with Similarweb.
Actions
| Action | What it does |
|---|---|
| Get country rank | Get country rank. |
| Get desktop bounce rate | Get desktop bounce rate. |
| Get desktop channel visits | Get desktop channel visits. |
| Get desktop geography | Get desktop geography. |
| Get desktop pages per visit | Get desktop pages per visit. |
| Get desktop referrals | Get desktop referrals. |
| Get desktop traffic sources | Get desktop traffic sources. |
| Get desktop visit duration | Get desktop visit duration. |
| Get desktop visits | Get desktop visits. |
| Get global rank | Get global rank. |
| Get industry rank | Get industry rank. |
| Get mobile bounce rate | Get mobile bounce rate. |
| Get mobile geography | Get mobile geography. |
| Get mobile pages per visit | Get mobile pages per visit. |
| Get mobile referrals | Get mobile referrals. |
| Get mobile traffic sources | Get mobile traffic sources. |
| Get mobile visit duration | Get mobile visit duration. |
| Get mobile visits | Get mobile visits. |
| Get similar sites | Get similar sites. |
| Get social referrals | Get social referrals. |
| Get total bounce rate | Get total bounce rate. |
| Get total geography | Get total geography. |
| Get total pages per visit | Get total pages per visit. |
| Get total visit duration | Get total visit duration. |
| Get total visits | Get total visits. |
Get country rank
Get country rank. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"country_rank": [],
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"start_date": "2023-01-01"
},
"status": "Success"
}
},
"has_more": false,
"next_cursor": null
}Get desktop bounce rate
Get desktop bounce rate. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - State
statetext - [optional] Select the US state on which to filter the data. Only available when country = US, leave blank otherwise! Supported states: az, ca, ga, fl, il, ma, mi, nj, ny, nc, oh, pa, tx, va, wa.
- Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"bounce_rate": [],
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "az"
},
"status": "Success"
}
},
"has_more": false,
"next_cursor": null
}Get desktop channel visits
Get desktop channel visits. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Limit
limittext - [optional] Select the number of results that are returned. Default = 100.
- Offset
offsettext - [optional] Specify an offset from where to start returning data.
- Sort
sorttext - [optional] The metric you'd like the results to be ordered by.
- Asc
asctext - [optional] The order of results. Enter "true" for ascending, or "false" for descending.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"query": {
"asc": "example",
"limit": 100,
"offset": 0,
"sort": "example"
},
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"main_domain_only": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
},
"overview": [],
"visits": 436221796
},
"has_more": false,
"next_cursor": null
}Get desktop geography
Get desktop geography. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Limit
limittext - [optional] Select the number of results that are returned. Default = 100.
- Offset
offsettext - [optional] Specify an offset from where to start returning data.
- Sort
sorttext - [optional] The metric you'd like the results to be ordered by.
- Asc
asctext - [optional] The order of results. Enter "true" for ascending, or "false" for descending.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-06-16",
"query": {
"asc": "example",
"limit": 100,
"offset": 0,
"sort": "example"
},
"request": {
"country": "world",
"domain": "cnn.com",
"end_date": "example",
"format": "json",
"main_domain_only": false,
"show_verified": false,
"start_date": "example",
"state": "example"
},
"status": "Success"
},
"records": []
},
"has_more": false,
"next_cursor": null
}Get desktop pages per visit
Get desktop pages per visit. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - State
statetext - [optional] Select the US state on which to filter the data. Only available when country = US, leave blank otherwise! Supported states: az, ca, ga, fl, il, ma, mi, nj, ny, nc, oh, pa, tx, va, wa.
- Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
- Engaged only
engaged_onlytrue/false - [optional] When 'true', the data is filtered by 'engaged visits' only.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "az"
},
"status": "Success"
},
"pages_per_visit": []
},
"has_more": false,
"next_cursor": null
}Get desktop referrals
Get desktop referrals. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Limit
limittext - [optional] Select the number of results that are returned. Default = 100.
- Offset
offsettext - [optional] Specify an offset from where to start returning data.
- Sort
sorttext - [optional] The metric you'd like the results to be ordered by.
- Asc
asctext - [optional] The order of results. Enter "true" for ascending, or "false" for descending.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"category": "News_and_Media",
"category_ranking": 13,
"global_ranking": 88,
"meta": {
"last_updated": "2023-05-31",
"query": {
"asc": "example",
"limit": 100,
"offset": 0,
"sort": "example"
},
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"main_domain_only": false,
"show_verified": false,
"start_date": "2023-02-01",
"state": "example"
},
"status": "Success"
},
"referrals": [],
"visits": 6574173
},
"has_more": false,
"next_cursor": null
}Get desktop traffic sources
Get desktop traffic sources. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
},
"visits": {
"cnn.com": []
}
},
"has_more": false,
"next_cursor": null
}Get desktop visit duration
Get desktop visit duration. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - State
statetext - [optional] Select the US state on which to filter the data. Only available when country = US, leave blank otherwise! Supported states: az, ca, ga, fl, il, ma, mi, nj, ny, nc, oh, pa, tx, va, wa.
- Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
- Engaged only
engaged_onlytrue/false - [optional] When 'true', the data is filtered by 'engaged visits' only.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"average_visit_duration": [],
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "az"
},
"status": "Success"
}
},
"has_more": false,
"next_cursor": null
}Get desktop visits
Get desktop visits. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - State
statetext - [optional] Select the US state on which to filter the data. Only available when country = US, leave blank otherwise! Supported states: az, ca, ga, fl, il, ma, mi, nj, ny, nc, oh, pa, tx, va, wa.
- Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
- Engaged only
engaged_onlytrue/false - [optional] When 'true', the data is filtered by 'engaged visits' only.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"device": "Desktop",
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "az"
},
"status": "Success"
},
"visits": []
},
"has_more": false,
"next_cursor": null
}Get global rank
Get global rank. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"global_rank": [],
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "world",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"main_domain_only": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
}
},
"has_more": false,
"next_cursor": null
}Get industry rank
Get industry rank. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"category": "E-commerce_and_Shopping/Marketplace",
"meta": {
"request": {
"domain": "amazon.com",
"format": "json"
},
"status": "Success"
},
"rank": 1
},
"has_more": false,
"next_cursor": null
}Get mobile bounce rate
Get mobile bounce rate. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"bounce_rate": [],
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "gb",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
}
},
"has_more": false,
"next_cursor": null
}Get mobile geography
Get mobile geography. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Limit
limittext - [optional] Select the number of results that are returned. Default = 100.
- Offset
offsettext - [optional] Specify an offset from where to start returning data.
- Sort
sorttext - [optional] The metric you'd like the results to be ordered by.
- Asc
asctext - [optional] The order of results. Enter "true" for ascending, or "false" for descending.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"query": {
"asc": "example",
"limit": 100,
"offset": 0,
"sort": "example"
},
"request": {
"country": "world",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"main_domain_only": false,
"show_verified": false,
"start_date": "2023-03-01",
"state": "example"
},
"status": "Success"
},
"records": []
},
"has_more": false,
"next_cursor": null
}Get mobile pages per visit
Get mobile pages per visit. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
- Engaged only
engaged_onlytrue/false - [optional] When 'true', the data is filtered by 'engaged visits' only.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "gb",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
},
"pages_per_visit": []
},
"has_more": false,
"next_cursor": null
}Get mobile referrals
Get mobile referrals. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedateRequired - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedateRequired - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Limit
limittext - [optional] Select the number of results that are returned. Default = 100.
- Offset
offsettext - [optional] Specify an offset from where to start returning data.
- Sort
sorttext - [optional] The metric you'd like the results to be ordered by.
- Asc
asctext - [optional] The order of results. Enter "true" for ascending, or "false" for descending.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"category": "News_and_Media",
"category_ranking": 13,
"global_ranking": 88,
"meta": {
"last_updated": "2023-05-31",
"query": {
"asc": "example",
"limit": 100,
"offset": 0,
"sort": "example"
},
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"main_domain_only": false,
"show_verified": false,
"start_date": "2023-02-01",
"state": "example"
},
"status": "Success"
},
"referrals": [],
"visits": 27246508
},
"has_more": false,
"next_cursor": null
}Get mobile traffic sources
Get mobile traffic sources. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedateRequired - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedateRequired - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - This endpoint only supports monthly currently.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Fomat
fomattext - [optional] Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
},
"visits": {
"cnn.com": []
}
},
"has_more": false,
"next_cursor": null
}Get mobile visit duration
Get mobile visit duration. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
- Engaged only
engaged_onlytrue/false - [optional] When 'true', the data is filtered by 'engaged visits' only.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"average_visit_duration": [],
"meta": {
"last_updated": "2022-09-30",
"request": {
"country": "gb",
"domain": "amazon.com",
"end_date": "2022-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2022-01-01",
"state": "example"
},
"status": "Success"
}
},
"has_more": false,
"next_cursor": null
}Get mobile visits
Get mobile visits. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
- Engaged only
engaged_onlytrue/false - [optional] When 'true', the data is filtered by 'engaged visits' only.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
},
"visits": []
},
"has_more": false,
"next_cursor": null
}Get similar sites
Get similar sites. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Limit
limittext - [optional] Select the number of results that are returned. Maximum = 40.
- Offset
offsettext - [optional] Specify an offset from where to start returning data.
- Sort
sorttext - [optional] The metric you'd like the results to be ordered by.
- Asc
asctext - [optional] The order of results. Enter "true" for ascending, or "false" for descending.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"category": "News_and_Media",
"category_ranking": 14,
"global_ranking": 91,
"meta": {
"query": {
"asc": "example",
"limit": 20,
"offset": 0,
"sort": "example"
},
"request": {
"country": "world",
"domain": "cnn.com",
"end_date": "example",
"format": "json",
"main_domain_only": false,
"show_verified": false,
"start_date": "example",
"state": "example"
},
"status": "Success"
},
"similar_sites": []
},
"has_more": false,
"next_cursor": null
}Get social referrals
Get social referrals. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Limit
limittext - [optional] Select the number of results that are returned. Default = 100.
- Offset
offsettext - [optional] Specify an offset from where to start returning data.
- Sort
sorttext - [optional] The metric you'd like the results to be ordered by.
- Asc
asctext - [optional] The order of results. Enter "true" for ascending, or "false" for descending.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"query": {
"asc": "example",
"limit": 100,
"offset": 0,
"sort": "example"
},
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"main_domain_only": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
},
"social": [],
"visits": 11723719
},
"has_more": false,
"next_cursor": null
}Get total bounce rate
Get total bounce rate. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"bounce_rate": [],
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
}
},
"has_more": false,
"next_cursor": null
}Get total geography
Get total geography. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}.
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Limit
limittext - [optional] Select the number of results that are returned. Default = 100.
- Offset
offsettext - [optional] Specify an offset from where to start returning data.
- Sort
sorttext - [optional] The metric you'd like the results to be ordered by.
- Asc
asctext - [optional] The order of results. Enter "true" for ascending, or "false" for descending.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"query": {
"asc": "example",
"limit": 100,
"offset": 0,
"sort": "example"
},
"request": {
"country": "world",
"domain": "cnn.com",
"end_date": "2023-03-31",
"format": "json",
"main_domain_only": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
},
"records": []
},
"has_more": false,
"next_cursor": null
}Get total pages per visit
Get total pages per visit. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
- Engaged only
engaged_onlytrue/false - [optional] When 'true', the data is filtered by 'engaged visits' only.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "amazon.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
},
"pages_per_visit": []
},
"has_more": false,
"next_cursor": null
}Get total visit duration
Get total visit duration. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'.
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
- Engaged only
engaged_onlytrue/false - [optional] When 'true', the data is filtered by 'engaged visits' only.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"average_visit_duration": [],
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "amazon.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
}
},
"has_more": false,
"next_cursor": null
}Get total visits
Get total visits. Returns one response page; the connected account determines access.
Inputs
- Domain name
domain_nametextRequired - Enter website of interest, without 'www.' or brackets {}
- Start date
start_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- End date
end_datedate - Choose a date in the month to report. Sent as YYYY-MM.
- Country
countrytextRequired - 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.One of:
world,ad,ae,af,ag,ai,al,am,ao,aq, and 241 more. - Granularity
granularitytextRequired - Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of:
daily,weekly,monthly. - Main domain only
main_domain_onlytrue/false - [optional] Return values for the main domain only ('true'), or include also the subdomains ('false')
- Show verified
show_verifiedtrue/false - [optional] Show shared Google Analytics data when available. Default value is 'false'
- Mtd
mtdtrue/false - [optional] When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'. Default value is 'false'.
- Engaged only
engaged_onlytrue/false - [optional] When 'true', the data is filtered by 'engaged visits' only.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"meta": {
"last_updated": "2023-05-31",
"request": {
"country": "us",
"domain": "amazon.com",
"end_date": "2023-03-31",
"format": "json",
"granularity": "Monthly",
"main_domain_only": false,
"mtd": false,
"show_verified": false,
"start_date": "2023-01-01",
"state": "example"
},
"status": "Success"
},
"visits": []
},
"has_more": false,
"next_cursor": null
}