Similarweb

App · 25 actions

Research website visits, engagement, rankings, geography and traffic channels with Similarweb.

Actions

ActionWhat it does
Get country rankGet country rank.
Get desktop bounce rateGet desktop bounce rate.
Get desktop channel visitsGet desktop channel visits.
Get desktop geographyGet desktop geography.
Get desktop pages per visitGet desktop pages per visit.
Get desktop referralsGet desktop referrals.
Get desktop traffic sourcesGet desktop traffic sources.
Get desktop visit durationGet desktop visit duration.
Get desktop visitsGet desktop visits.
Get global rankGet global rank.
Get industry rankGet industry rank.
Get mobile bounce rateGet mobile bounce rate.
Get mobile geographyGet mobile geography.
Get mobile pages per visitGet mobile pages per visit.
Get mobile referralsGet mobile referrals.
Get mobile traffic sourcesGet mobile traffic sources.
Get mobile visit durationGet mobile visit duration.
Get mobile visitsGet mobile visits.
Get similar sitesGet similar sites.
Get social referralsGet social referrals.
Get total bounce rateGet total bounce rate.
Get total geographyGet total geography.
Get total pages per visitGet total pages per visit.
Get total visit durationGet total visit duration.
Get total visitsGet total visits.

Get country rank

Get country rank. Returns one response page; the connected account determines access.

Inputs

Domain namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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 onlymain_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Statestatetext
[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 onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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 onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Limitlimittext
[optional] Select the number of results that are returned. Default = 100.
Offsetoffsettext
[optional] Specify an offset from where to start returning data.
Sortsorttext
[optional] The metric you'd like the results to be ordered by.
Ascasctext
[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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Limitlimittext
[optional] Select the number of results that are returned. Default = 100.
Offsetoffsettext
[optional] Specify an offset from where to start returning data.
Sortsorttext
[optional] The metric you'd like the results to be ordered by.
Ascasctext
[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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Statestatetext
[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 onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 onlyengaged_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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 onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Limitlimittext
[optional] Select the number of results that are returned. Default = 100.
Offsetoffsettext
[optional] Specify an offset from where to start returning data.
Sortsorttext
[optional] The metric you'd like the results to be ordered by.
Ascasctext
[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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Mtdmtdtrue/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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Statestatetext
[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 onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 onlyengaged_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Statestatetext
[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 onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Mtdmtdtrue/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 onlyengaged_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
Main domain onlymain_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 namedomain_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Limitlimittext
[optional] Select the number of results that are returned. Default = 100.
Offsetoffsettext
[optional] Specify an offset from where to start returning data.
Sortsorttext
[optional] The metric you'd like the results to be ordered by.
Ascasctext
[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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 onlyengaged_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedateRequired
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedateRequired
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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 onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Limitlimittext
[optional] Select the number of results that are returned. Default = 100.
Offsetoffsettext
[optional] Specify an offset from where to start returning data.
Sortsorttext
[optional] The metric you'd like the results to be ordered by.
Ascasctext
[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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedateRequired
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedateRequired
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
This endpoint only supports monthly currently.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Fomatfomattext
[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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 onlyengaged_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 onlyengaged_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Limitlimittext
[optional] Select the number of results that are returned. Maximum = 40.
Offsetoffsettext
[optional] Specify an offset from where to start returning data.
Sortsorttext
[optional] The metric you'd like the results to be ordered by.
Ascasctext
[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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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 onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Limitlimittext
[optional] Select the number of results that are returned. Default = 100.
Offsetoffsettext
[optional] Specify an offset from where to start returning data.
Sortsorttext
[optional] The metric you'd like the results to be ordered by.
Ascasctext
[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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}.
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Limitlimittext
[optional] Select the number of results that are returned. Default = 100.
Offsetoffsettext
[optional] Specify an offset from where to start returning data.
Sortsorttext
[optional] The metric you'd like the results to be ordered by.
Ascasctext
[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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 onlyengaged_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false').
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'.
Mtdmtdtrue/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 onlyengaged_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 namedomain_nametextRequired
Enter website of interest, without 'www.' or brackets {}
Start datestart_datedate
Choose a date in the month to report. Sent as YYYY-MM.
End dateend_datedate
Choose a date in the month to report. Sent as YYYY-MM.
CountrycountrytextRequired
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.
GranularitygranularitytextRequired
Set the granularity for the returned values. Can be 'daily', 'weekly' or 'monthly'.One of: daily, weekly, monthly.
Main domain onlymain_domain_onlytrue/false
[optional] Return values for the main domain only ('true'), or include also the subdomains ('false')
Show verifiedshow_verifiedtrue/false
[optional] Show shared Google Analytics data when available. Default value is 'false'
Mtdmtdtrue/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 onlyengaged_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
}

On this page