You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Add batch_analysis() method for the Batch Analysis POST endpoint
- Add BatchAnalysisRequest, BatchAnalysisTarget, BatchAnalysisData types
- Add POST request support in both sync and async clients
- Bump version to 0.3.0
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/api-reference.md
+65-2Lines changed: 65 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,69 @@ For filter expression syntax (`where` parameter), see [Filter Syntax](filter-syn
11
11
12
12
---
13
13
14
+
## Batch Analysis
15
+
16
+
### `batch_analysis()`
17
+
18
+
Batch Analysis.
19
+
20
+
**Parameters:**
21
+
22
+
| Name | Type | Required | Description |
23
+
|------|------|----------|-------------|
24
+
|`select`|`list[str]`| Yes | A list of columns to return. See response schema for valid column identifiers. |
25
+
|`order_by`|`str`| No ||
26
+
|`country`|`CountryEnum`| No | A two-letter country code (ISO 3166-1 alpha-2). |
27
+
|`volume_mode`|`VolumeModeEnum`| No | The search volume calculation mode: monthly or average. It affects volume, traffic, and traffic value. |
28
+
|`targets`|`list[BatchAnalysisTarget]`| Yes | A list of targets to do batch analysis. |
29
+
30
+
**Returns:**`list[BatchAnalysisData]`
31
+
32
+
<details>
33
+
<summary>35 fields</summary>
34
+
35
+
| Field | Type | Description |
36
+
|-------|------|-------------|
37
+
|`ahrefs_rank`|`int \| None`| The strength of your target's backlink profile compared to the other websites in our database, with rank #1 being the strongest. |
38
+
|`backlinks`|`int \| None`| The total number of links from other websites pointing to your target. |
39
+
|`backlinks_dofollow`|`int \| None`| Links to your target that do not contain a “nofollow”, “ugc”, or “sponsored” value in their “rel” attribute. These links are also called “dofollow”. |
40
+
|`backlinks_internal`|`int \| None`| The total number of internal links pointing to the target's pages. |
41
+
|`backlinks_nofollow`|`int \| None`| Links to your target that contain a “nofollow”, “ugc”, or “sponsored” value in their “rel” attribute. |
42
+
|`backlinks_redirect`|`int \| None`| Links pointing to your target via a redirect. |
43
+
|`domain_rating`|`float \| None`| The strength of your target's backlink profile compared to the other websites in our database on a 100-point logarithmic scale. |
44
+
|`index`|`int`| Target index number. |
45
+
|`ip`|`str \| None`| The IP address of the target. |
46
+
|`linked_domains`|`int \| None`| The number of unique domains linked from your target. |
47
+
|`linked_domains_dofollow`|`int \| None`| The number of unique domains linked from your target with followed links. |
48
+
|`mode`|`str`| The target mode used for the analysis. Depending on the selected mode (Exact URL, Path, Domain, Subdomains), different parts of the website will be analyzed. |
49
+
|`org_cost`|`int \| None`| (10 units) The estimated value of your target’s monthly organic search traffic. |
50
+
|`org_keywords`|`int \| None`| The total number of keywords that your target ranks for in the top 100 organic search results. When ranking for the same keyword across different locations in “All locations” mode, it's still counted as one keyword. |
51
+
|`org_keywords_11_20`|`int \| None`| The total number of unique keywords for which your target's top organic ranking position is within the 11th to 20th results. When ranking for the same keyword across different locations in “All locations” mode, it's still counted as one keyword. |
52
+
|`org_keywords_1_3`|`int \| None`| The total number of unique keywords for which your target's top organic ranking position is within the top 3 results. When ranking for the same keyword across different locations in “All locations” mode, it's still counted as one keyword. |
53
+
|`org_keywords_21_50`|`int \| None`| The total number of unique keywords for which your target's top organic ranking position is within the 21st to 50th results. When ranking for the same keyword across different locations in “All locations” mode, it's still counted as one keyword. |
54
+
|`org_keywords_4_10`|`int \| None`| The total number of unique keywords for which your target's top organic ranking position is within the 4th to 10th results. When ranking for the same keyword across different locations in “All locations” mode, it's still counted as one keyword. |
55
+
|`org_keywords_51_plus`|`int \| None`| The total number of unique keywords for which your target's top organic ranking position is the 51st result or higher. When ranking for the same keyword across different locations in “All locations” mode, it's still counted as one keyword. |
56
+
|`org_traffic`|`int \| None`| (10 units) The estimated number of monthly visits that your target gets from organic search. |
57
+
|`org_traffic_top_by_country`|`list[list[Any] \| None]`| (10 units) Top countries by traffic with corresponding traffic values. (Currently only a single element is being returned with the country with the most traffic.) |
58
+
|`outgoing_links`|`int \| None`| The total number of links from your target to other domains. |
59
+
|`outgoing_links_dofollow`|`int \| None`| The total number of followed links from your target to other domains. |
60
+
|`paid_ads`|`int \| None`| The total number of unique ads of a target website or URL in paid search results. |
61
+
|`paid_cost`|`int \| None`| (10 units) The estimated cost of your target’s monthly paid search traffic. |
62
+
|`paid_keywords`|`int \| None`| The total number of keywords that your target ranks for in paid search results. When ranking for the same keyword across different locations in “All locations” mode, it's still counted as one keyword. |
63
+
|`paid_traffic`|`int \| None`| (10 units) The estimated number of monthly visits that your target gets from paid search. |
64
+
|`protocol`|`str`| The protocol of the target. Possible values: `both`, `http`, `https`. |
65
+
|`refdomains`|`int \| None`| (5 units) The total number of unique domains linking to your target. |
66
+
|`refdomains_dofollow`|`int \| None`| (5 units) The number of unique domains with links to your target that do not contain a “nofollow”, “ugc”, or “sponsored” value in their “rel” attribute. These links are also called “dofollow”. |
67
+
|`refdomains_nofollow`|`int \| None`| (5 units) The number of unique domains that only have links to your target containing a “nofollow”, “ugc”, or “sponsored” value in their “rel” attribute. |
68
+
|`refips`|`int \| None`| The number of unique IP addresses with at least one domain pointing to your target. Several domains can share one IP address. |
69
+
|`refips_subnets`|`int \| None`| The number of c-class IP networks (AAA.BBB.CCC.DDD) with at least one link to your target. Example: 151.80.39.61 is the website IP address where 151.80.39.XXX is the subnet. |
70
+
|`url`|`str`| The URL of the analyzed target. |
71
+
|`url_rating`|`float \| None`| URL Rating (UR) shows the strength of your target page's backlink profile on a 100-point logarithmic scale. If you analyze a domain, the homepage's UR is shown. |
72
+
73
+
</details>
74
+
75
+
---
76
+
14
77
## Brand Radar
15
78
16
79
### `brand_radar_ai_responses()`
@@ -886,7 +949,7 @@ SERP Overview.
886
949
887
950
## Serp Overview
888
951
889
-
### `serp_overview_serp_overview()`
952
+
### `serp_overview()`
890
953
891
954
SERP Overview.
892
955
@@ -900,7 +963,7 @@ SERP Overview.
900
963
|`country`|`CountryEnum`| Yes | A two-letter country code (ISO 3166-1 alpha-2). |
901
964
|`keyword`|`str`| Yes | The keyword to return SERP Overview for. |
0 commit comments