Skip to content

Commit b5fcb57

Browse files
waleedlatif1waleedlatif1
committed
update docs
1 parent cc22cbf commit b5fcb57

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+1774
-1759
lines changed

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

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ Get a list of backlinks pointing to a target domain or URL. Returns details abou
6060

6161
| Parameter | Type | Required | Description |
6262
| --------- | ---- | -------- | ----------- |
63-
| `target` | string | Yes | The target domain or URL to analyze |
64-
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
63+
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
64+
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
6565
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
66-
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
67-
| `offset` | number | No | Number of results to skip for pagination |
66+
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
67+
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
6868
| `apiKey` | string | Yes | Ahrefs API Key |
6969

7070
#### Output
@@ -88,8 +88,8 @@ Get backlink statistics for a target domain or URL. Returns totals for different
8888

8989
| Parameter | Type | Required | Description |
9090
| --------- | ---- | -------- | ----------- |
91-
| `target` | string | Yes | The target domain or URL to analyze |
92-
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
91+
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
92+
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
9393
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
9494
| `apiKey` | string | Yes | Ahrefs API Key |
9595

@@ -113,11 +113,11 @@ Get a list of domains that link to a target domain or URL. Returns unique referr
113113

114114
| Parameter | Type | Required | Description |
115115
| --------- | ---- | -------- | ----------- |
116-
| `target` | string | Yes | The target domain or URL to analyze |
117-
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
116+
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
117+
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
118118
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
119-
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
120-
| `offset` | number | No | Number of results to skip for pagination |
119+
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
120+
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
121121
| `apiKey` | string | Yes | Ahrefs API Key |
122122

123123
#### Output
@@ -140,12 +140,12 @@ Get organic keywords that a target domain or URL ranks for in Google search resu
140140

141141
| Parameter | Type | Required | Description |
142142
| --------- | ---- | -------- | ----------- |
143-
| `target` | string | Yes | The target domain or URL to analyze |
144-
| `country` | string | No | Country code for search results \(e.g., us, gb, de\). Default: us |
145-
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
143+
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
144+
| `country` | string | No | Country code for search results. Example: "us", "gb", "de" \(default: "us"\) |
145+
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
146146
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
147-
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
148-
| `offset` | number | No | Number of results to skip for pagination |
147+
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
148+
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
149149
| `apiKey` | string | Yes | Ahrefs API Key |
150150

151151
#### Output
@@ -168,12 +168,12 @@ Get the top pages of a target domain sorted by organic traffic. Returns page URL
168168

169169
| Parameter | Type | Required | Description |
170170
| --------- | ---- | -------- | ----------- |
171-
| `target` | string | Yes | The target domain to analyze |
172-
| `country` | string | No | Country code for traffic data \(e.g., us, gb, de\). Default: us |
173-
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\) |
171+
| `target` | string | Yes | The target domain to analyze. Example: "example.com" |
172+
| `country` | string | No | Country code for traffic data. Example: "us", "gb", "de" \(default: "us"\) |
173+
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\). Example: "domain" |
174174
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
175-
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
176-
| `offset` | number | No | Number of results to skip for pagination |
175+
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
176+
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
177177
| `select` | string | No | Comma-separated list of fields to return \(e.g., url,traffic,keywords,top_keyword,value\). Default: url,traffic,keywords,top_keyword,value |
178178
| `apiKey` | string | Yes | Ahrefs API Key |
179179

@@ -197,7 +197,7 @@ Get detailed metrics for a keyword including search volume, keyword difficulty,
197197
| Parameter | Type | Required | Description |
198198
| --------- | ---- | -------- | ----------- |
199199
| `keyword` | string | Yes | The keyword to analyze |
200-
| `country` | string | No | Country code for keyword data \(e.g., us, gb, de\). Default: us |
200+
| `country` | string | No | Country code for keyword data. Example: "us", "gb", "de" \(default: "us"\) |
201201
| `apiKey` | string | Yes | Ahrefs API Key |
202202

203203
#### Output
@@ -222,11 +222,11 @@ Get a list of broken backlinks pointing to a target domain or URL. Useful for id
222222

223223
| Parameter | Type | Required | Description |
224224
| --------- | ---- | -------- | ----------- |
225-
| `target` | string | Yes | The target domain or URL to analyze |
226-
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
225+
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" |
226+
| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" |
227227
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
228-
| `limit` | number | No | Maximum number of results to return \(default: 100\) |
229-
| `offset` | number | No | Number of results to skip for pagination |
228+
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) |
229+
| `offset` | number | No | Number of results to skip for pagination. Example: 100 |
230230
| `apiKey` | string | Yes | Ahrefs API Key |
231231

232232
#### Output

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Read records from an Airtable table
4040

4141
| Parameter | Type | Required | Description |
4242
| --------- | ---- | -------- | ----------- |
43-
| `baseId` | string | Yes | ID of the Airtable base |
44-
| `tableId` | string | Yes | ID of the table |
45-
| `maxRecords` | number | No | Maximum number of records to return |
43+
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
44+
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
45+
| `maxRecords` | number | No | Maximum number of records to return \(default: all records\) |
4646
| `filterFormula` | string | No | Formula to filter records \(e.g., "\(\{Field Name\} = \'Value\'\)"\) |
4747

4848
#### Output
@@ -60,9 +60,9 @@ Retrieve a single record from an Airtable table by its ID
6060

6161
| Parameter | Type | Required | Description |
6262
| --------- | ---- | -------- | ----------- |
63-
| `baseId` | string | Yes | ID of the Airtable base |
64-
| `tableId` | string | Yes | ID or name of the table |
65-
| `recordId` | string | Yes | ID of the record to retrieve |
63+
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
64+
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
65+
| `recordId` | string | Yes | Record ID to retrieve \(starts with "rec", e.g., "recXXXXXXXXXXXXXX"\) |
6666

6767
#### Output
6868

@@ -79,8 +79,8 @@ Write new records to an Airtable table
7979

8080
| Parameter | Type | Required | Description |
8181
| --------- | ---- | -------- | ----------- |
82-
| `baseId` | string | Yes | ID of the Airtable base |
83-
| `tableId` | string | Yes | ID or name of the table |
82+
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
83+
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
8484
| `records` | json | Yes | Array of records to create, each with a `fields` object |
8585
| `fields` | string | No | No description |
8686

@@ -99,9 +99,9 @@ Update an existing record in an Airtable table by ID
9999

100100
| Parameter | Type | Required | Description |
101101
| --------- | ---- | -------- | ----------- |
102-
| `baseId` | string | Yes | ID of the Airtable base |
103-
| `tableId` | string | Yes | ID or name of the table |
104-
| `recordId` | string | Yes | ID of the record to update |
102+
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
103+
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
104+
| `recordId` | string | Yes | Record ID to update \(starts with "rec", e.g., "recXXXXXXXXXXXXXX"\) |
105105
| `fields` | json | Yes | An object containing the field names and their new values |
106106

107107
#### Output
@@ -119,8 +119,8 @@ Update multiple existing records in an Airtable table
119119

120120
| Parameter | Type | Required | Description |
121121
| --------- | ---- | -------- | ----------- |
122-
| `baseId` | string | Yes | ID of the Airtable base |
123-
| `tableId` | string | Yes | ID or name of the table |
122+
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) |
123+
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name |
124124
| `records` | json | Yes | Array of records to update, each with an `id` and a `fields` object |
125125

126126
#### Output

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

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,12 @@ Run an APIFY actor synchronously and get results (max 5 minutes)
4545
| Parameter | Type | Required | Description |
4646
| --------- | ---- | -------- | ----------- |
4747
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
48-
| `actorId` | string | Yes | Actor ID or username/actor-name \(e.g., "janedoe/my-actor" or actor ID\) |
49-
| `input` | string | No | Actor input as JSON string. See actor documentation for required fields. |
50-
| `timeout` | number | No | Timeout in seconds \(default: actor default\) |
51-
| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
48+
| `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" |
49+
| `input` | string | No | Actor input as JSON string. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} |
50+
| `Example` | string | No | No description |
51+
| `memory` | number | No | Memory in megabytes allocated for the actor run \(128-32768\). Example: 1024 for 1GB, 2048 for 2GB |
52+
| `timeout` | number | No | Timeout in seconds for the actor run. Example: 300 for 5 minutes, 3600 for 1 hour |
53+
| `build` | string | No | Actor build to run. Examples: "latest", "beta", "1.2.3", "build-tag-name" |
5254

5355
#### Output
5456

@@ -68,12 +70,14 @@ Run an APIFY actor asynchronously with polling for long-running tasks
6870
| Parameter | Type | Required | Description |
6971
| --------- | ---- | -------- | ----------- |
7072
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
71-
| `actorId` | string | Yes | Actor ID or username/actor-name \(e.g., "janedoe/my-actor" or actor ID\) |
72-
| `input` | string | No | Actor input as JSON string |
73-
| `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts |
74-
| `itemLimit` | number | No | Max dataset items to fetch \(1-250000, default 100\) |
75-
| `timeout` | number | No | Timeout in seconds \(default: actor default\) |
76-
| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
73+
| `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" |
74+
| `input` | string | No | Actor input as JSON string. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} |
75+
| `Example` | string | No | No description |
76+
| `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts. Example: 30 |
77+
| `itemLimit` | number | No | Max dataset items to fetch \(1-250000\). Default: 100. Example: 500 |
78+
| `memory` | number | No | Memory in megabytes allocated for the actor run \(128-32768\). Example: 1024 for 1GB, 2048 for 2GB |
79+
| `timeout` | number | No | Timeout in seconds for the actor run. Example: 300 for 5 minutes, 3600 for 1 hour |
80+
| `build` | string | No | Actor build to run. Examples: "latest", "beta", "1.2.3", "build-tag-name" |
7781

7882
#### Output
7983

0 commit comments

Comments
 (0)