Skip to content

Commit dd2f0c6

Browse files
waleedlatif1waleedlatif1
authored
feat(tools): added similarweb (#3071)
1 parent f99518b commit dd2f0c6

File tree

16 files changed

+1336
-27
lines changed

16 files changed

+1336
-27
lines changed

‎apps/docs/components/icons.tsx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5114,6 +5114,24 @@ export function PulseIcon(props: SVGProps<SVGSVGElement>) {
51145114
)
51155115
}
51165116

5117+
export function SimilarwebIcon(props: SVGProps<SVGSVGElement>) {
5118+
return (
5119+
<svg
5120+
{...props}
5121+
role='img'
5122+
viewBox='0 0 24 24'
5123+
xmlns='http://www.w3.org/2000/svg'
5124+
height='24'
5125+
width='24'
5126+
>
5127+
<path
5128+
d='M22.099 5.781c-1.283 -2 -3.14 -3.67 -5.27 -4.52l-0.63 -0.213a7.433 7.433 0 0 0 -2.15 -0.331c-2.307 0.01 -4.175 1.92 -4.175 4.275a4.3 4.3 0 0 0 0.867 2.602l-0.26 -0.342c0.124 0.186 0.26 0.37 0.417 0.556 0.663 0.802 1.604 1.635 2.822 2.58 2.999 2.32 4.943 4.378 5.104 6.93 0.038 0.344 0.062 0.696 0.062 1.051 0 1.297 -0.283 2.67 -0.764 3.635h0.005s-0.207 0.377 -0.077 0.487c0.066 0.057 0.21 0.1 0.46 -0.053a12.104 12.104 0 0 0 3.4 -3.33 12.111 12.111 0 0 0 2.088 -6.635 12.098 12.098 0 0 0 -1.9 -6.692zm-9.096 8.718 -1.878 -1.55c-3.934 -2.87 -5.98 -5.966 -4.859 -9.783a8.73 8.73 0 0 1 0.37 -1.016v-0.004s0.278 -0.583 -0.327 -0.295a12.067 12.067 0 0 0 -6.292 9.975 12.11 12.11 0 0 0 2.053 7.421 9.394 9.394 0 0 0 2.154 2.168H4.22c4.148 3.053 7.706 1.446 7.706 1.446h0.003a4.847 4.847 0 0 0 2.962 -4.492 4.855 4.855 0 0 0 -1.889 -3.87z'
5129+
fill='currentColor'
5130+
/>
5131+
</svg>
5132+
)
5133+
}
5134+
51175135
export function CalComIcon(props: SVGProps<SVGSVGElement>) {
51185136
return (
51195137
<svg

‎apps/docs/components/ui/icon-mapping.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ import {
101101
ServiceNowIcon,
102102
SftpIcon,
103103
ShopifyIcon,
104+
SimilarwebIcon,
104105
SlackIcon,
105106
SmtpIcon,
106107
SQSIcon,
@@ -230,6 +231,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
230231
sftp: SftpIcon,
231232
sharepoint: MicrosoftSharepointIcon,
232233
shopify: ShopifyIcon,
234+
similarweb: SimilarwebIcon,
233235
slack: SlackIcon,
234236
smtp: SmtpIcon,
235237
sqs: SQSIcon,

‎apps/docs/content/docs/en/tools/meta.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@
9797
"sftp",
9898
"sharepoint",
9999
"shopify",
100+
"similarweb",
100101
"slack",
101102
"smtp",
102103
"sqs",

‎apps/docs/content/docs/en/tools/similarweb.mdx‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
---
2+
title: Similarweb
3+
description: Website traffic and analytics data
4+
---
5+
6+
import { BlockInfoCard } from "@/components/ui/block-info-card"
7+
8+
<BlockInfoCard
9+
type="similarweb"
10+
color="#000922"
11+
/>
12+
13+
{/* MANUAL-CONTENT-START:intro */}
14+
[Similarweb](https://www.similarweb.com/) is a leading platform for web analytics that provides in-depth traffic and engagement data for millions of websites. Similarweb gives you insights into website visits, traffic sources, audience behavior, and competitive benchmarks.
15+
16+
With Similarweb in Sim, your agents can:
17+
18+
- **Analyze website traffic**: Retrieve key metrics such as monthly visits, average duration, bounce rates, and top countries.
19+
- **Understand audience engagement**: Gain insights into how users interact with websites, including pages per visit and engagement duration.
20+
- **Track rankings and performance**: Access global, country, and category ranks to benchmark sites against competitors.
21+
- **Discover traffic sources**: Break down traffic by channels like direct, search, social, referrals, and more.
22+
23+
Use Sim's Similarweb integration to automate the monitoring of competitors, track your site’s performance, or surface actionable market research—all integrated directly into your workflows and automations. Empower your agents to access and utilize reliable web analytics data easily and programmatically.
24+
{/* MANUAL-CONTENT-END */}
25+
26+
27+
## Usage Instructions
28+
29+
Access comprehensive website analytics including traffic estimates, engagement metrics, rankings, and traffic sources using the Similarweb API.
30+
31+
32+
33+
## Tools
34+
35+
### `similarweb_website_overview`
36+
37+
Get comprehensive website analytics including traffic, rankings, engagement, and traffic sources
38+
39+
#### Input
40+
41+
| Parameter | Type | Required | Description |
42+
| --------- | ---- | -------- | ----------- |
43+
| `apiKey` | string | Yes | SimilarWeb API key |
44+
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
45+
46+
#### Output
47+
48+
| Parameter | Type | Description |
49+
| --------- | ---- | ----------- |
50+
| `siteName` | string | Website name |
51+
| `description` | string | Website description |
52+
| `globalRank` | number | Global traffic rank |
53+
| `countryRank` | number | Country traffic rank |
54+
| `categoryRank` | number | Category traffic rank |
55+
| `category` | string | Website category |
56+
| `monthlyVisits` | number | Estimated monthly visits |
57+
| `engagementVisitDuration` | number | Average visit duration in seconds |
58+
| `engagementPagesPerVisit` | number | Average pages per visit |
59+
| `engagementBounceRate` | number | Bounce rate \(0-1\) |
60+
| `topCountries` | array | Top countries by traffic share |
61+
| ↳ `country` | string | Country code |
62+
| ↳ `share` | number | Traffic share \(0-1\) |
63+
| `trafficSources` | json | Traffic source breakdown |
64+
| ↳ `direct` | number | Direct traffic share |
65+
| ↳ `referrals` | number | Referral traffic share |
66+
| ↳ `search` | number | Search traffic share |
67+
| ↳ `social` | number | Social traffic share |
68+
| ↳ `mail` | number | Email traffic share |
69+
| ↳ `paidReferrals` | number | Paid referral traffic share |
70+
71+
### `similarweb_traffic_visits`
72+
73+
Get total website visits over time (desktop and mobile combined)
74+
75+
#### Input
76+
77+
| Parameter | Type | Required | Description |
78+
| --------- | ---- | -------- | ----------- |
79+
| `apiKey` | string | Yes | SimilarWeb API key |
80+
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
81+
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
82+
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
83+
| `startDate` | string | No | Start date in YYYY-MM format |
84+
| `endDate` | string | No | End date in YYYY-MM format |
85+
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
86+
87+
#### Output
88+
89+
| Parameter | Type | Description |
90+
| --------- | ---- | ----------- |
91+
| `domain` | string | Analyzed domain |
92+
| `country` | string | Country filter applied |
93+
| `granularity` | string | Data granularity |
94+
| `lastUpdated` | string | Data last updated timestamp |
95+
| `visits` | array | Visit data over time |
96+
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
97+
| ↳ `visits` | number | Number of visits |
98+
99+
### `similarweb_bounce_rate`
100+
101+
Get website bounce rate over time (desktop and mobile combined)
102+
103+
#### Input
104+
105+
| Parameter | Type | Required | Description |
106+
| --------- | ---- | -------- | ----------- |
107+
| `apiKey` | string | Yes | SimilarWeb API key |
108+
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
109+
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
110+
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
111+
| `startDate` | string | No | Start date in YYYY-MM format |
112+
| `endDate` | string | No | End date in YYYY-MM format |
113+
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
114+
115+
#### Output
116+
117+
| Parameter | Type | Description |
118+
| --------- | ---- | ----------- |
119+
| `domain` | string | Analyzed domain |
120+
| `country` | string | Country filter applied |
121+
| `granularity` | string | Data granularity |
122+
| `lastUpdated` | string | Data last updated timestamp |
123+
| `bounceRate` | array | Bounce rate data over time |
124+
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
125+
| ↳ `bounceRate` | number | Bounce rate \(0-1\) |
126+
127+
### `similarweb_pages_per_visit`
128+
129+
Get average pages per visit over time (desktop and mobile combined)
130+
131+
#### Input
132+
133+
| Parameter | Type | Required | Description |
134+
| --------- | ---- | -------- | ----------- |
135+
| `apiKey` | string | Yes | SimilarWeb API key |
136+
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
137+
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
138+
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
139+
| `startDate` | string | No | Start date in YYYY-MM format |
140+
| `endDate` | string | No | End date in YYYY-MM format |
141+
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
142+
143+
#### Output
144+
145+
| Parameter | Type | Description |
146+
| --------- | ---- | ----------- |
147+
| `domain` | string | Analyzed domain |
148+
| `country` | string | Country filter applied |
149+
| `granularity` | string | Data granularity |
150+
| `lastUpdated` | string | Data last updated timestamp |
151+
| `pagesPerVisit` | array | Pages per visit data over time |
152+
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
153+
| ↳ `pagesPerVisit` | number | Average pages per visit |
154+
155+
### `similarweb_visit_duration`
156+
157+
Get average desktop visit duration over time (in seconds)
158+
159+
#### Input
160+
161+
| Parameter | Type | Required | Description |
162+
| --------- | ---- | -------- | ----------- |
163+
| `apiKey` | string | Yes | SimilarWeb API key |
164+
| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) |
165+
| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data |
166+
| `granularity` | string | Yes | Data granularity: daily, weekly, or monthly |
167+
| `startDate` | string | No | Start date in YYYY-MM format |
168+
| `endDate` | string | No | End date in YYYY-MM format |
169+
| `mainDomainOnly` | boolean | No | Exclude subdomains from results |
170+
171+
#### Output
172+
173+
| Parameter | Type | Description |
174+
| --------- | ---- | ----------- |
175+
| `domain` | string | Analyzed domain |
176+
| `country` | string | Country filter applied |
177+
| `granularity` | string | Data granularity |
178+
| `lastUpdated` | string | Data last updated timestamp |
179+
| `averageVisitDuration` | array | Desktop visit duration data over time |
180+
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
181+
| ↳ `durationSeconds` | number | Average visit duration in seconds |
182+
183+

‎apps/docs/content/docs/en/tools/youtube.mdx‎

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -26,38 +26,12 @@ In Sim, the YouTube integration enables your agents to programmatically search a
2626

2727
## Usage Instructions
2828

29-
Integrate YouTube into the workflow. Can search for videos, get trending videos, get video details, get video captions, get video categories, get channel information, get all videos from a channel, get channel playlists, get playlist items, and get video comments.
29+
Integrate YouTube into the workflow. Can search for videos, get trending videos, get video details, get video categories, get channel information, get all videos from a channel, get channel playlists, get playlist items, and get video comments.
3030

3131

3232

3333
## Tools
3434

35-
### `youtube_captions`
36-
37-
List available caption tracks (subtitles/transcripts) for a YouTube video. Returns information about each caption including language, type, and whether it is auto-generated.
38-
39-
#### Input
40-
41-
| Parameter | Type | Required | Description |
42-
| --------- | ---- | -------- | ----------- |
43-
| `videoId` | string | Yes | YouTube video ID to get captions for |
44-
| `apiKey` | string | Yes | YouTube API Key |
45-
46-
#### Output
47-
48-
| Parameter | Type | Description |
49-
| --------- | ---- | ----------- |
50-
| `items` | array | Array of available caption tracks for the video |
51-
| ↳ `captionId` | string | Caption track ID |
52-
| ↳ `language` | string | Language code of the caption \(e.g., |
53-
| ↳ `name` | string | Name/label of the caption track |
54-
| ↳ `trackKind` | string | Type of caption track: |
55-
| ↳ `lastUpdated` | string | When the caption was last updated |
56-
| ↳ `isCC` | boolean | Whether this is a closed caption track |
57-
| ↳ `isAutoSynced` | boolean | Whether the caption timing was automatically synced |
58-
| ↳ `audioTrackType` | string | Type of audio track this caption is for |
59-
| `totalResults` | number | Total number of caption tracks available |
60-
6135
### `youtube_channel_info`
6236

6337
Get detailed information about a YouTube channel including statistics, branding, and content details.

0 commit comments

Comments
 (0)