# Similarweb (/integrations/similarweb) {/* MANUAL-CONTENT-START:intro */} Use [Similarweb](https://www.similarweb.com/) to retrieve website traffic estimates, visit duration, bounce rate, pages per visit, country breakdowns, rankings, and traffic sources. Compare sites or report changes across the selected periods. These are provider estimates rather than your site's measured analytics. Use the selected operation's geographic, time-period, and granularity fields to keep comparisons consistent. {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] Retrieve website analytics including traffic estimates, engagement metrics, rankings, and traffic sources using the Similarweb API. ## Actions [#actions] ### SimilarWeb Website Overview [#similarweb-website-overview] Get website traffic, rankings, engagement, and traffic sources. #### Input [#input] | Parameter | Type | Required | Description | | - | - | - | - | | `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze (e.g., "example.com" without www or protocol) | #### Output [#output] | Parameter | Type | Description | | - | - | - | | `siteName` | string | Website name | | `description` | string | Website description | | `globalRank` | number | Global traffic rank | | `countryRank` | number | Country traffic rank | | `categoryRank` | number | Category traffic rank | | `category` | string | Website category | | `monthlyVisits` | number | Estimated monthly visits | | `engagementVisitDuration` | number | Average visit duration in seconds | | `engagementPagesPerVisit` | number | Average pages per visit | | `engagementBounceRate` | number | Bounce rate (0-1) | | `topCountries` | array | Top countries by traffic share | | ↳ `country` | string | Country code | | ↳ `share` | number | Traffic share (0-1) | | `trafficSources` | json | Traffic source breakdown | | ↳ `direct` | number | Direct traffic share | | ↳ `referrals` | number | Referral traffic share | | ↳ `search` | number | Search traffic share | | ↳ `social` | number | Social traffic share | | ↳ `mail` | number | Email traffic share | | ↳ `paidReferrals` | number | Paid referral traffic share | ### SimilarWeb Traffic Visits [#similarweb-traffic-visits] Get total website visits over time (desktop and mobile combined) #### Input [#input-1] | Parameter | Type | Required | Description | | - | - | - | - | | `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze (e.g., "example.com" without www or protocol) | | `country` | string | Yes | 2-letter ISO country code (e.g., "us", "gb", "de") or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | | `startDate` | string | No | Start date in YYYY-MM format (e.g., "2024-01") | | `endDate` | string | No | End date in YYYY-MM format (e.g., "2024-12") | | `mainDomainOnly` | boolean | No | Exclude subdomains from results | #### Output [#output-1] | Parameter | Type | Description | | - | - | - | | `domain` | string | Analyzed domain | | `country` | string | Country filter applied | | `granularity` | string | Data granularity | | `lastUpdated` | string | Data last updated timestamp | | `visits` | array | Visit data over time | | ↳ `date` | string | Date (YYYY-MM-DD) | | ↳ `visits` | number | Number of visits | ### SimilarWeb Bounce Rate [#similarweb-bounce-rate] Get website bounce rate over time (desktop and mobile combined) #### Input [#input-2] | Parameter | Type | Required | Description | | - | - | - | - | | `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze (e.g., "example.com" without www or protocol) | | `country` | string | Yes | 2-letter ISO country code (e.g., "us", "gb", "de") or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | | `startDate` | string | No | Start date in YYYY-MM format (e.g., "2024-01") | | `endDate` | string | No | End date in YYYY-MM format (e.g., "2024-12") | | `mainDomainOnly` | boolean | No | Exclude subdomains from results | #### Output [#output-2] | Parameter | Type | Description | | - | - | - | | `domain` | string | Analyzed domain | | `country` | string | Country filter applied | | `granularity` | string | Data granularity | | `lastUpdated` | string | Data last updated timestamp | | `bounceRate` | array | Bounce rate data over time | | ↳ `date` | string | Date (YYYY-MM-DD) | | ↳ `bounceRate` | number | Bounce rate (0-1) | ### SimilarWeb Pages Per Visit [#similarweb-pages-per-visit] Get average pages per visit over time (desktop and mobile combined) #### Input [#input-3] | Parameter | Type | Required | Description | | - | - | - | - | | `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze (e.g., "example.com" without www or protocol) | | `country` | string | Yes | 2-letter ISO country code (e.g., "us", "gb", "de") or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | | `startDate` | string | No | Start date in YYYY-MM format (e.g., "2024-01") | | `endDate` | string | No | End date in YYYY-MM format (e.g., "2024-12") | | `mainDomainOnly` | boolean | No | Exclude subdomains from results | #### Output [#output-3] | Parameter | Type | Description | | - | - | - | | `domain` | string | Analyzed domain | | `country` | string | Country filter applied | | `granularity` | string | Data granularity | | `lastUpdated` | string | Data last updated timestamp | | `pagesPerVisit` | array | Pages per visit data over time | | ↳ `date` | string | Date (YYYY-MM-DD) | | ↳ `pagesPerVisit` | number | Average pages per visit | ### SimilarWeb Visit Duration [#similarweb-visit-duration] Get average desktop visit duration over time (in seconds) #### Input [#input-4] | Parameter | Type | Required | Description | | - | - | - | - | | `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze (e.g., "example.com" without www or protocol) | | `country` | string | Yes | 2-letter ISO country code (e.g., "us", "gb", "de") or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | | `startDate` | string | No | Start date in YYYY-MM format (e.g., "2024-01") | | `endDate` | string | No | End date in YYYY-MM format (e.g., "2024-12") | | `mainDomainOnly` | boolean | No | Exclude subdomains from results | #### Output [#output-4] | Parameter | Type | Description | | - | - | - | | `domain` | string | Analyzed domain | | `country` | string | Country filter applied | | `granularity` | string | Data granularity | | `lastUpdated` | string | Data last updated timestamp | | `averageVisitDuration` | array | Desktop visit duration data over time | | ↳ `date` | string | Date (YYYY-MM-DD) | | ↳ `durationSeconds` | number | Average visit duration in seconds | ### SimilarWeb Page Views [#similarweb-page-views] Get total page views over time (desktop and mobile combined) #### Input [#input-5] | Parameter | Type | Required | Description | | - | - | - | - | | `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze (e.g., "example.com" without www or protocol) | | `country` | string | Yes | 2-letter ISO country code (e.g., "us", "gb", "de") or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | | `startDate` | string | No | Start date in YYYY-MM format (e.g., "2024-01") | | `endDate` | string | No | End date in YYYY-MM format (e.g., "2024-12") | | `mainDomainOnly` | boolean | No | Exclude subdomains from results | #### Output [#output-5] | Parameter | Type | Description | | - | - | - | | `domain` | string | Analyzed domain | | `country` | string | Country filter applied | | `granularity` | string | Data granularity | | `lastUpdated` | string | Data last updated timestamp | | `pageViews` | array | Page view data over time | | ↳ `date` | string | Date (YYYY-MM-DD) | | ↳ `pageViews` | number | Total page views |