Developer
Telephone
United States
+1 (800) 815 - 9959
10:00 AM - 5:00 PM (EST/EDT)
Monday - Friday
Basic docs
Analytics
Last updated: May 10, 2024
Last updated: May 10, 2024
About
It's a group of products with Analytics reports including:
- Domain Analytics
- Organic Research
- Advertising Research
- Keyword Gap Analysis
- Keyword Analytics
- Backlink Analytics
Authentication
Request authentication is provided via API keys. An API key is assigned to each user after subscribing to Semrush. You'll find it in Subscription info > API units. If your API key is unavailable there, refer to How to get API documentation.
Never share your API key publicly. If you share an API call example, replace your key with a placeholder such as https://api.semrush.com/?key=<key>.
Your API key also gives access to your API unit balance. Exposing your credentials can result in your account being compromised, which could lead to unexpected charges.
Columns
Tips and tricks:
- Column names can't be changed
- Order of columns can be changed
- Number of columns can be increased
- Semrush will only remove old columns after notifying users
| Name | Description |
|---|---|
| Ab | Place on the SERP where an ad appeared (top, side, or bottom blocks). |
| Ac | Estimated budget spent buying keywords in Google Ads for ads that appear in paid search results (monthly estimation). |
| Ad | Keywords a website is buying in Google Ads for ads that appear in paid search results. |
| Am | Changes in the number of paid keywords. |
| At | Traffic brought to the website via paid search results. |
| Bm | Changes in paid traffic. |
| Cg | Total cost of all traffic driven to an analyzed domain with a given keyword over a specific period of time. |
| Cm | Changes in paid traffic price. |
| Co | Competitive density of advertisers using the given term for their ads. One (1) means the highest competition. |
| Cp | Average price in USD advertisers pay for a user's click on an ad containing a particular keyword (Google AdWords). |
| Cr | Competition level based on the total number of keywords of each domain and the number of keywords the domains have in common. |
| Cv | Keyword coverage represents the percentage of ads displayed for a particular keyword in the last 12 months (100% = 12 months). |
| Db | Regional database (US, UK, Italy, etc.). |
| Dn | Domain name. |
| Ds | Ad text. |
| Dt | Actual date. |
| Fk | All SERP Features triggered by a keyword. List of available SERP Features |
| Fp | SERP features in which a domain appears on SERP for a keyword. List of available SERP Features |
| Fl | (Deprecated) SERP features in which a domain appears on SERP for a keyword. List of available SERP Features |
| FKn | Total number of SERP Features triggered by the keywords that your domain ranks for. Columns with specified numbers should be separated with commas: FK1,FK2..FKn, where n is the number of a SERP feature from this list. |
| FPn | Total number of SERP Features that your domain ranks in. Columns with changed numbers should be separated with commas: FP1,FP2..FPn, where n is the number of a SERP feature from this list. |
| Hs | Whether or not a report's line returns historical data. |
| Ip | IP address. |
| In | Keyword intents (0 - Commercial, 1 - Informational, 2 - Navigational, 3 - Transactional). |
| Ipu | Total number of positions with unknown intent. |
| Ip0 | Total number of positions with the Commercial intent. |
| Ip1 | Total number of positions with the Informational intent. |
| Ip2 | Total number of positions with the Navigational intent. |
| Ip3 | Total number of positions with the Transactional intent. |
| Itu | Total amount of traffic with unknown intent. |
| It0 | Total amount of traffic with the Commercial intent. |
| It1 | Total amount of traffic with the Informational intent. |
| It2 | Total amount of traffic with the Navigational intent. |
| It3 | Total amount of traffic with the Transactional intent. |
| Icu | Total cost of traffic with unknown intent. |
| Ic0 | Total cost of traffic with the Commercial intent. |
| Ic1 | Total cost of traffic with the Informational intent. |
| Ic2 | Total cost of traffic with the Navigational intent. |
| Ic3 | Total cost of traffic with the Transactional intent. |
| Kd | Estimate of how difficult it would be to rank well in organic search results for a particular keyword. The higher the percentage, the harder it is to achieve high rankings for the given keyword. |
| Lc | Number of API units per line. |
| Li | Number of lines requested for a report by a particular user. |
| Np | Common keywords that domains are ranking for in Google's top 100 organic search results. |
| Nq | Average number of times users have searched for a given keyword per month. We calculate this value over the last 12 months. |
| Nr | Total number of organic results returned for a given keyword at the last date of collection. |
| Oc | Estimated price of organic keywords in Google AdWords. |
| Oe | Keywords that the domain is still ranking for within the top 100 positions for, but has moved up in ranking since their previous position. |
| Of | Value of the display_offset parameter requested by a particular user. |
| Oi | Results that have decreased in ranking, yet still remain in the top 100. |
| Ol | Keywords that the domain was previously ranking for within the top 100 positions, but isn't any longer. |
| Om | Changes in the number of organic keywords. |
| On | New keywords that the domain is ranking for within the top 100 organic results based on the chosen time period. |
| Or | Keywords that bring users to a website via Google's top 100 organic search results. |
| Ot | Traffic brought to a website via Google's top 100 organic search results. |
| P0 | Position of the first queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| P1 | Position of the second queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| P2 | Position of the third queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| P3 | Position of the fourth queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| P4 | Position of the fifth queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| Pc | Number of keywords. |
| Pd | Difference between the previous position a domain was earning with a particular keyword and its current position. |
| Ph | Keyword bringing users to the website via Google's top 100 organic search results. |
| Po | Position the URL gets with a particular keyword in Google's top 100 organic or paid search results. |
| Pp | Position the domain gets with a particular keyword in Google's top 100 organic or paid search results. |
| Pr | Price of promoted product. |
| Pt | Type of position (the regular organic position or the specific SERP Feature). |
| Rh | Semrush rating of the website's popularity based on organic traffic coming from Google's top 100 organic search results. |
| Rk | Semrush rating of the website's popularity based on organic traffic coming from Google's top 100 organic search results. |
| Rr | Degree of relevance of the result keyword to the seed keyword. |
| Rt | Report type. |
| Sc | Estimated price to pay for the PPC ads to rank for the keywords where the domain is ranking in the SERP Features. |
| Scm | Changes in the organic traffic cost driven by SERP Feature positions. |
| Sh | Number of keywords the website is using for product listing ads. |
| Sn | Shop name. |
| Sv | Number of unique product listing ads (PLA Copies). |
| Sr | Number of keywords where the domain ranks in SERP Features. |
| Srb | Number of branded keywords where the domain ranks in SERP Features. |
| Srl | Keywords that the domain was previously ranking for in SERP Features, but isn't any longer. |
| Srm | Changes in the number of keywords with SERP Feature positions. |
| Srn | New keywords that the domain is ranking for in SERP Features based on the chosen time period. |
| St | Amount of estimated organic traffic driven to an analyzed domain from a SERP Feature position over a specific period of time. |
| Stb | Amount of estimated organic traffic driven to an analyzed domain from a SERP Feature position on a branded keyword over a specific period of time. |
| Stm | Changes in the traffic driven by SERP Feature postions. |
| Tc | Percentage of the domain's total traffic cost that is attributed to a particular keyword. |
| Tg | Amount of estimated organic traffic driven to an analyzed domain with a given keyword over a specific period of time. |
| Td | Interest of searchers in a particular keyword during the last 12 months. This metric is based on changes in the number of queries per month. |
| Tm | Changes in organic traffic. |
| Tr | Share of traffic driven to the website with a particular keyword for a specified period. |
| Ts | UNIX Timestamp. |
| Tt | Ad title. |
| Um | Changes in organic traffic cost. |
| Un | Ad ID. |
| Ur | URL of the target page (Backlinks). |
| Vu | Visible URL. |
| Xn |
Organic Position Distribution. Keywords bringing users to the website via Google's top 100 organic search results are grouped depending on the domain’s ranking for them. Columns with specified numbers should be separated with commas: X0,X1..X9,XA, where n is: 0: 1-3 1: 4-10 2: 11-20 3: 21-30 4: 31-40 5: 41-50 6: 51-60 7: 61-70 8: 71-80 9: 81-90 A: 91-100 |
| anchor | Clickable backlink text. |
| ascore | Authority Score is a Semrush proprietary metric used to measure the overall quality of the domain/URL and its influence on SEO. The score is based on the number of backlinks, referring domains, organic search traffic, and other data. |
| avg_positions | Average ad position. |
| backlinks_num | Number of backlinks to a given domain. |
| category_name | Name of the category. Categories may consist of one, two or three levels. Levels are divided by a slash (/). Example of one-level category: “/Business & Industrial”. Example of three-level category: “/Internet & Telecom/Web Services/Web Design & Development” |
| common_refdomains | The number of referring domains that link back to both the analyzed and competing domains. |
| domain | Domain name. |
| domain_ascore | Domain Authority Score is our proprietary metric used to measure overall quality of domain and influence on SEO. The score is based on the number of backlinks, referring domains, organic search traffic, and other data. |
| domain_overall | Total number of advertisers on Google’s Display Network where a publisher promoted a website, or the total number of publishers’ websites where the display ads of an advertiser's website appeared during a whole period. |
| domains_num | Total number of domains, including common referring domains, linking to a given domain. |
| external_num | Number of the source page's links that point to pages of other websites. |
| first_seen | Timestamp on which Semrush first noticed a backlink. |
| image_alt | URL of the image backlink's location. |
| internal_num | Number of the source page’s links that point to webpages of the same website. |
| ipclassc_num | Number of unique IP addresses of referring domains belonging to class C. Class C networks range from 192.0.0.0 through 223.255.255.0, with the network number contained in the first three octets. |
| ips_num | Number of unique IP addresses hosting referring domains. |
| last_seen | Timestamp on which Semrush last noticed a backlink. |
| media_ads_count | Total number of media display ads of an advertiser Semrush has noticed during a specified period. |
| media_ads_overall | Total number of an advertiser’s media display ads Semrush has noticed for a whole period. |
| media_type | Display ad's type of media. |
| neighbour | Domain with a similar backlink profile to the analyzed domain. |
| page_ascore | Page Authority Score is a proprietary Semrush metric used to measure the overall quality of the URL and its influence on SEO. The score is based on the number of backlinks, referring domains, organic search traffic, and other data. |
| publishers_count | Total number of publishers' websites where display ads of an advertiser's website appeared in the last 7 days. |
| publishers_overall | Total number of publishers’ websites where the display ads of an advertiser's website appeared during a whole period. |
| rating | Level of confidence that this domain belongs to this category (ranged from 0 to 1). |
| redirect_url | Last URL in a redirect chain. |
| response_code | Server response code. |
| similarity | This metric is calculated based on the number of referring domains to each competitor and the total number of common referring domains to all competitors. If websites have a large number of common referring domains, they can be considered competitors. |
| source_title | Title of the source page. |
| source_size | Size of the source page in bytes. |
| source_url | URL of the source page. |
| target_title | Title of the target page. |
| target_url | URL of the target page (Backlinks). |
| target_url | Landing page of a display ad (Display Advertising). |
| text | Text of a display ad. |
| text_ads_count | Total number of display ads during a specified period. |
| text_ads_overall | Total number of display ads Semrush noticed for a whole period. |
| times_seen | Number of times Semrush saw a display ad. |
| title | Title of a display ad. |
| total | Total number of backlinks leading to an analyzed domain/URL. |
| type | Backlink type. |
| ugc_num | Number of backlinks identified as User Generated Content (UGC). |
| visible_url | Visible URL of a display ad. |
| zone | Domain TLD. |
Show all
Databases
Regional database types:
- Desktop: Specified as a two-letter code.
- Mobile: Specified as a two-letter code with the
mobile-prefix. - Extended: Specified as a two-letter code with the
-extsuffix.
Mobile and extended databases aren't available for any requests in the Keyword reports.
| Code | Region | Research types | Google search domain |
|---|---|---|---|
| us | United States | Organic, Adwords, PLA, Keywords | google.com |
| uk | United Kingdom | Organic, Adwords, PLA, Keywords | google.co.uk |
| ca | Canada | Organic, Adwords, PLA, Keywords | google.ca |
| ru | Russia | Organic, Adwords, PLA, Keywords | google.ru |
| de | Germany | Organic, Adwords, PLA, Keywords | google.de |
| fr | France | Organic, Adwords, PLA, Keywords | google.fr |
| es | Spain | Organic, Adwords, PLA, Keywords | google.es |
| it | Italy | Organic, Adwords, PLA, Keywords | google.it |
| br | Brazil | Organic, Adwords, PLA, Keywords | google.com.br |
| au | Australia | Organic, Adwords, PLA, Keywords | google.com.au |
| ar | Argentina | Organic, Adwords, PLA, Keywords | google.com.ar |
| be | Belgium | Organic, Adwords, PLA, Keywords | google.be |
| ch | Switzerland | Organic, Adwords, PLA, Keywords | google.ch |
| dk | Denmark | Organic, Adwords, PLA, Keywords | google.dk |
| fi | Finland | Organic, Adwords, Keywords | google.fi |
| hk | Hong Kong | Organic, Adwords, PLA, Keywords | google.com.hk |
| ie | Ireland | Organic, Adwords, PLA, Keywords | google.ie |
| il | Israel | Organic, Adwords, Keywords | google.co.il |
| mx | Mexico | Organic, Adwords, PLA, Keywords | google.com.mx |
| nl | Netherlands | Organic, Adwords, PLA, Keywords | google.nl |
| no | Norway | Organic, Adwords, PLA, Keywords | google.no |
| pl | Poland | Organic, Adwords, PLA, Keywords | google.pl |
| se | Sweden | Organic, Adwords, PLA, Keywords | google.se |
| sg | Singapore | Organic, Adwords, PLA, Keywords | google.com.sg |
| tr | Turkey | Organic, Adwords, PLA, Keywords | google.com.tr |
| jp | Japan | Organic, Adwords, PLA, Keywords | google.co.jp |
| in | India | Organic, Adwords, PLA, Keywords | google.co.in |
| hu | Hungary | Organic, Adwords, Keywords | google.hu |
| af | Afghanistan | Organic, Adwords, Keywords | google.com.af |
| al | Albania | Organic, Adwords, Keywords | google.al |
| dz | Algeria | Organic, Adwords, Keywords | google.dz |
| ao | Angola | Organic, Adwords, Keywords | google.co.ao |
| am | Armenia | Organic, Adwords, Keywords | google.am |
| at | Austria | Organic, Adwords, PLA, Keywords | google.at |
| az | Azerbaijan | Organic, Adwords, Keywords | google.az |
| bh | Bahrain | Organic, Adwords, Keywords | google.com.bh |
| bd | Bangladesh | Organic, Adwords, Keywords | google.com.bd |
| by | Belarus | Organic, Adwords, Keywords | google.by |
| bz | Belize | Organic, Adwords, Keywords | google.com.bz |
| bo | Bolivia | Organic, Adwords, Keywords | google.com.bo |
| ba | Bosnia and Herzegovina | Organic, Adwords, Keywords | google.ba |
| bw | Botswana | Organic, Adwords, Keywords | google.co.bw |
| bn | Brunei | Organic, Adwords, Keywords | google.com.bn |
| bg | Bulgaria | Organic, Adwords, Keywords | google.bg |
| cv | Cabo Verde | Organic, Adwords, Keywords | google.cv |
| kh | Cambodia | Organic, Adwords, Keywords | google.com.kh |
| cm | Cameroon | Organic, Adwords, Keywords | google.cm |
| cl | Chile | Organic, Adwords, PLA, Keywords | google.cl |
| co | Colombia | Organic, Adwords, PLA, Keywords | google.com.co |
| cr | Costa Rica | Organic, Adwords, Keywords | google.co.cr |
| hr | Croatia | Organic, Adwords, Keywords | google.hr |
| cy | Cyprus | Organic, Adwords, Keywords | google.com.cy |
| cz | Czech Republic | Organic, Adwords, PLA, Keywords | google.cz |
| cd | Congo | Organic, Adwords, Keywords | google.cd |
| do | Dominican Republic | Organic, Adwords, Keywords | google.com.do |
| ec | Ecuador | Organic, Adwords, Keywords | google.com.ec |
| eg | Egypt | Organic, Adwords, Keywords | google.com.eg |
| sv | El Salvador | Organic, Adwords, Keywords | google.com.sv |
| ee | Estonia | Organic, Adwords, Keywords | google.ee |
| et | Ethiopia | Organic, Adwords, Keywords | google.com.et |
| ge | Georgia | Organic, Adwords, Keywords | google.ge |
| gh | Ghana | Organic, Adwords, Keywords | google.com.gh |
| gr | Greece | Organic, Adwords, Keywords | google.gr |
| gt | Guatemala | Organic, Adwords, Keywords | google.com.gt |
| gy | Guyana | Organic, Adwords, Keywords | google.gy |
| ht | Haiti | Organic, Adwords, Keywords | google.ht |
| hn | Honduras | Organic, Adwords, Keywords | google.hn |
| is | Iceland | Organic, Adwords, Keywords | google.is |
| id | Indonesia | Organic, Adwords, PLA, Keywords | google.co.id |
| jm | Jamaica | Organic, Adwords, Keywords | google.com.jm |
| jo | Jordan | Organic, Adwords, Keywords | google.jo |
| kz | Kazakhstan | Organic, Adwords, Keywords | google.kz |
| kw | Kuwait | Organic, Adwords, Keywords | google.com.kw |
| lv | Latvia | Organic, Adwords, Keywords | google.lv |
| lb | Lebanon | Organic, Adwords, Keywords | google.com.lb |
| lt | Lithuania | Organic, Adwords, Keywords | google.lt |
| lu | Luxembourg | Organic, Adwords, Keywords | google.lu |
| mg | Madagascar | Organic, Adwords, Keywords | google.mg |
| my | Malaysia | Organic, Adwords, PLA, Keywords | google.com.my |
| mt | Malta | Organic, Adwords, Keywords | google.com.mt |
| mu | Mauritius | Organic, Adwords, Keywords | google.mu |
| md | Moldova | Organic, Adwords, Keywords | google.md |
| mn | Mongolia | Organic, Adwords, Keywords | google.mn |
| me | Montenegro | Organic, Adwords, Keywords | google.me |
| ma | Morocco | Organic, Adwords, Keywords | google.co.ma |
| mz | Mozambique | Organic, Adwords, Keywords | google.co.mz |
| na | Namibia | Organic, Adwords, Keywords | google.com.na |
| np | Nepal | Organic, Adwords, Keywords | google.com.np |
| nz | New Zealand | Organic, Adwords, PLA, Keywords | google.co.nz |
| ni | Nicaragua | Organic, Adwords, Keywords | google.com.ni |
| ng | Nigeria | Organic, Adwords, Keywords | google.com.ng |
| om | Oman | Organic, Adwords, Keywords | google.com.om |
| py | Paraguay | Organic, Adwords, Keywords | google.com.py |
| pe | Peru | Organic, Adwords, Keywords | google.com.pe |
| ph | Philippines | Organic, Adwords, PLA, Keywords | google.com.ph |
| pt | Portugal | Organic, Adwords, PLA, Keywords | google.pt |
| ro | Romania | Organic, Adwords, Keywords | google.ro |
| sa | Saudi Arabia | Organic, Adwords, Keywords | google.com.sa |
| sn | Senegal | Organic, Adwords, Keywords | google.sn |
| rs | Serbia | Organic, Adwords, Keywords | google.rs |
| sk | Slovakia | Organic, Adwords, Keywords | google.sk |
| si | Slovenia | Organic, Adwords, Keywords | google.si |
| za | South Africa | Organic, Adwords, PLA, Keywords | google.co.za |
| kr | South Korea | Organic, Adwords, Keywords | google.co.kr |
| lk | Sri Lanka | Organic, Adwords, Keywords | google.lk |
| th | Thailand | Organic, Adwords, Keywords | google.co.th |
| bs | Bahamas | Organic, Adwords, Keywords | google.bs |
| tt | Trinidad and Tobago | Organic, Adwords, Keywords | google.tt |
| tn | Tunisia | Organic, Adwords, Keywords | google.tn |
| ua | Ukraine | Organic, Adwords, Keywords | google.com.ua |
| ae | United Arab Emirates | Organic, Adwords, PLA, Keywords | google.ae |
| uy | Uruguay | Organic, Adwords, Keywords | google.com.uy |
| ve | Venezuela | Organic, Adwords, Keywords | google.co.ve |
| vn | Vietnam | Organic, Adwords, Keywords | google.com.vn |
| zm | Zambia | Organic, Adwords, Keywords | google.co.zm |
| zw | Zimbabwe | Organic, Adwords, Keywords | google.co.zw |
| ly | Libya | Organic, Adwords, Keywords | google.com.ly |
| mobile-us | United States | Organic, Adwords | google.com |
| mobile-uk | United Kingdom | Organic, Adwords | google.com |
| mobile-ca | Canada | Organic, Adwords | google.ca |
| mobile-de | Germany | Organic, Adwords | google.de |
| mobile-fr | France | Organic, Adwords | google.fr |
| mobile-es | Spain | Organic, Adwords | google.es |
| mobile-it | Italy | Organic, Adwords | google.it |
| mobile-br | Brazil | Organic, Adwords | google.com.br |
| mobile-au | Australia | Organic, Adwords | google.com.au |
| mobile-dk | Denmark | Organic, Adwords | google.dk |
| mobile-mx | Mexico | Organic, Adwords | google.com.mx |
| mobile-nl | Netherlands | Organic, Adwords | google.nl |
| mobile-se | Sweden | Organic, Adwords | google.se |
| mobile-tr | Turkey | Organic, Adwords | google.com.tr |
| mobile-in | India | Organic, Adwords | google.co.in |
| mobile-id | Indonesia | Organic, Adwords | google.co.id |
| mobile-il | Israel | Organic, Adwords | google.co.il |
| il-ext | Israel Ext | Organic, Adwords | google.co.il-ext |
| tr-ext | Turkey Ext | Organic, Adwords, PLA | google.co.tr-ext |
| dk-ext | Denmark Ext | Organic, Adwords | google.dk-ext |
| no-ext | Norway Ext | Organic, Adwords | google.no-ext |
| se-ext | Sweden Ext | Organic, Adwords | google.se-ext |
| fi-ext | Finland Ext | Organic, Adwords | google.fi-ext |
| ch-ext | Switzerland Ext | Organic, Adwords, PLA | google.ch-ext |
| mobile-il-ext | Israel Ext | Organic, Adwords | google.co.il-ext |
| pa | Panama | Organic, Adwords, Keywords | google.com.pa |
| pk | Pakistan | Organic, Adwords, Keywords | google.com.pk |
| tw | Taiwan | Organic, Adwords, Keywords | google.com.tw |
| qa | Qatar | Organic, Adwords, Keywords | google.com.qa |
Show all
Error messages
| Name | Description | Recommended action |
|---|---|---|
| ERROR 40 :: MANDATORY PARAMETER action NOT SET OR EMPTY | The required 'action' parameter is missing, or its value is not set. | Add the parameter to your request or set its value. |
| ERROR 41 :: MANDATORY PARAMETER type NOT SET OR EMPTY | The required 'type' parameter is missing, or its value is not set. | Add the parameter to your request or set its value. |
| ERROR 42 :: MANDATORY PARAMETER domain NOT SET OR EMPTY | The required 'domain' parameter is missing, or its value is not set. | Add the parameter to your request or set its value. |
| ERROR 43 :: MANDATORY PARAMETER phrase NOT SET OR EMPTY | The required 'phrase' parameter is missing, or its value is not set. | Add the parameter to your request or set its value. |
| ERROR 44 :: MANDATORY PARAMETER url NOT SET OR EMPTY | The required 'url' parameter is missing, or its value is not set. | Add the parameter to your request or set its value. |
| ERROR 46 :: MANDATORY PARAMETER database NOT SET OR EMPTY | The required 'database' parameter is missing, or its value is not set. | Add the parameter to your request or set its value. |
| ERROR 48 :: REQUEST METHOD NOT ALLOWED, USE GET | Invalid request method. | Use the HTTP GET method. |
| ERROR 50 :: NOTHING FOUND | No information related to your request was found. | Double-check the request parameters. If they are correct but yield no results, contact the Semrush Support Team and provide them with your API request. |
| ERROR 110 :: INVALID IMPORT KEY | The API key has an incorrect format. | Go to the Subscription info section to find the correct API key. |
| ERROR 120 :: WRONG KEY - ID PAIR | You tried to use an unknown API key. | Go to the Subscription info section to find the correct API key. |
| ERROR 130 :: API DISABLED | Your subscription doesn't let you use API. | Upgrade your subscription plan to get access to the API. |
| ERROR 131 :: LIMIT EXCEEDED | The API request limit for the requested report has been reached. | Contact the Semrush Support Team. |
| ERROR 132 :: API UNITS BALANCE IS ZERO | The API unit limit has been reached. | You have used all your API units. To continue using the API, recharge your balance or upgrade your subscription. |
| ERROR 133 :: DB ACCESS DENIED | You are not allowed to access the requested database. | Contact the Semrush Sales Team to get access to more databases. |
| ERROR 134 :: TOTAL LIMIT EXCEEDED | The total API request limit has been reached. | Contact the Semrush Support Team. |
| ERROR 135 :: API REPORT TYPE DISABLED | 1. The report you're trying to access is no longer available. 2. The subscription has ended. |
1. Check if there's another report that suits your needs or contact the Semrush Support Team. 2. Update your subscription or contact the Semrush Support Team. |
| ERROR 136 :: Multiple limits not allowed | Internal limit error. | Contact the Semrush Support Team. |
| ERROR 402 :: Request param not valid | The API key is incorrect. | Go to the Subscription info section to find the correct API key. |
| ERROR 402 :: Request param not valid :: Duplicate domains | The 'targets' parameter contains duplicated values. | Remove the duplicated values from the 'targets' parameter. |
| ERROR 404 :: Not found | Internal error. User information wasn't found in the Semrush database. | Contact the Semrush Support Team. |
| ERROR 500 :: Internal Error | Internal error. | Try again later or contact the Semrush Support Team. |
| ERROR 10000 :: Wrong parameter '{parameter}'. {description}. | Invalid parameter value. | Specify the value according to the description. |
| ERROR 10001 :: Wrong parameter '{parameter}'. {description}. | The parameter is duplicated. | Remove the duplicated parameter from your request. |
| ERROR 10010 :: Wrong parameter '{parameter}'. {description}. | The parameter value is out of range. | Specify the value according to the description. |
| ERROR 10011 :: Wrong parameter '{parameter}'. {description}. | The parameter value is less than the minimum value. | Specify the value according to the description. |
| ERROR 10012 :: Wrong parameter '{parameter}'. {description}. | The parameter value is greater than the maximum value. | Specify the value according to the description. |
| ERROR 10013 :: Wrong parameter '{parameter}'. {description}. | The required parameter is not specified. | Specify the required parameter. |
| ERROR 10014 :: Wrong parameter '{parameter}'. {description}. | The parameter has duplicated values. | Check the request and remove duplicate parameter values. |
| ERROR 10015 :: Wrong parameter '{parameter}'. {description}. | The parameter can't be used with other request parameter values. | Specify the parameters or values according to the description. |
| ERROR 10030 :: Wrong parameter '{parameter}'. {description}. | The parameter has too many values. | Check the request and reduce the number of values according to the description. |
| ERROR 10031 :: Wrong parameter '{parameter}'. {description}. | The parameter doesn't have enough values. | Check the request and the missing values according to the description. |
| ERROR 10040 :: Wrong parameter '{parameter}'. {description}. | The 'selected_targets' parameter mustn't contain more domains than 'targets' with the segment equal to 'excludes'. | Ensure 'selected_targets' aligns with the 'excludes' segment limit and adjust domains accordingly. |
| ERROR 10041 :: Wrong parameter '{parameter}'. {description}. | Not all the 'selected_targets' domains are specified in the 'targets' parameter. | In 'selected_targets', specify only those domains that are indicated in the 'targets' parameter. |
| ERROR 10042 :: Wrong parameter '{parameter}'. {description}. | Invalid parameter value. The value is not a domain. | Specify the domain. |
| ERROR 10043 :: Wrong parameter '{parameter}'. {description}. | Invalid parameter value. | Specify the first day of the month. |
| ERROR 10044 :: Wrong parameter '{parameter}'. {description}. | Invalid parameter value. | Specify the value according to the description. |
| ERROR 10045 :: Wrong parameter '{parameter}'. {description}. | Invalid parameter value. | Specify the value according to the description. |
Show all
Filters
To apply filters to a report, add the display_filter parameter with a URL-encoded string that contains filters separated by | (%7C). Max. number of filters that can be applied at once is 25.
A single filter consists of <sign>|<field>|<operation>|<value>, where:
<sign>:+(%2B) or-(%2D) to include or exclude the corresponding data.<field>: Possible fields are listed in the tables in the upcoming sections.<operation>: Possible operations are listed in the Operations section and depend on the field type.<value>: Possible values depend on the field.
Some ready-to-use functions might encode the + sign incorrectly. Make sure that it's encoded as %2B.
Example requests
Find keywords related to the target phrase with a search volume of less than 1000 (1 filter)
https://api.semrush.com/?type=phrase_related&key=YOUR_API_KEY&phrase=seo&export_columns=Ph,Nq,Cp,Co,Nr,Td,Rr,Fk&database=us&display_limit=10&display_sort=nq_desc&display_filter=%2B%7CNq%7CLt%7C1000
Find organic keywords with the transactional intent (1st filter) for which the target domain ranks below 5th position (2nd filter)
https://api.semrush.com/?type=domain_organic&key=YOUR_API_KEY&display_limit=10&export_columns=Ph,Po,Pp,Pd,Nq,Cp,Ur,Tr,In,Pp&domain=toyota.com&display_sort=tr_desc&database=us&display_filter=%2B%7CIn%7CEq%7C3%7C%2B%7CPp%7CGt%7C5
Metric fields
| Value | Description |
|---|---|
| Co | Competitive density of advertisers using the given term for their ads. One (1) indicates the highest competition. |
| Cp | Average price in USD that advertisers pay for a user's click on an ad containing a particular keyword (Google Ads). |
| Db | Regional database (US, UK, Italy, etc.). |
| Hs | Whether or not a report's line returns historical data. |
| Wc | Word Count. Allows to filter the results for keywords with certain number of terms in them. For example, "more than 3 words, but less than 5." |
| Nq | Average number of times users have searched for a given keyword per month. Semrush calculates this value over the last 12 months. |
| Nr | Total number of organic results returned for a given keyword on the last date of data gathering. |
| P0 | Position of the first queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| P1 | Position of the second queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| P2 | Position of the third queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| P3 | Position of the fourth queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| P4 | Position of the fifth queried domain for a particular keyword in Google's top 100 organic or paid search results. |
| Ph | Keyword bringing users to the website via Google's top 100 organic search results. You can enter multiple keywords by separating them with a comma. A comma is treated as an OR operator. Max. 300 characters. |
| Po | Position a URL is in for a particular keyword in Google's top 100 organic or paid search results. |
| Pp | Position of the Ad at the time of previous data gathering. |
| Pr | Price of promoted product. |
| Qu | Query. |
| Rt | Report type. |
| Tc | Percentage of the domain's total traffic cost that is attributed to a particular keyword. |
| Tr | Share of traffic driven to the website by a particular keyword for a specified period. |
| Ts | UNIX Timestamp. |
| Tt | Title of a product listing ad (PLA) that represents the name of a promoted product. |
| Ur | URL of the target page (Backlinks). |
| Vu | Visible URL. |
| In | Filter by keyword intent. Possible values: 0 (Commercial), 1 (Informational), 2 (Navigational), 3 (Transactional). |
| Ipu | Number of positions with unknown intent. |
| Ip0 | Number of positions with the Commercial intent. |
| Ip1 | Number of positions with the Informational intent. |
| Ip2 | Number of positions with the Navigational intent. |
| Ip3 | Number of positions with the Transactional intent. |
Show all
Text fields
| Value | Description | |
|---|---|---|
| Ph | Keyword bringing users to the URL via Google's top 100 organic search results. | |
| Qu | Query. | |
| Rt | Report type. | |
| Ur | URL displayed in search results for the given keyword. | |
| Vu | Display URL. This is the URL displayed on the Ad, identifying the site for users. | |
| title | Title of a text ad. | |
| text | Text of a text ad. | |
| ad | Concatenated title, text and visible URL of a text ad. | |
| url | Visible URL, target URL, or domain name. |
Show all
Fields with fixed values
| Value | Description | |
|---|---|---|
| Db | Regional database (US, UK, Italy, etc.). Possible values: 'us', 'uk', 'mobile-uk', 'ca', 'mobile-ca', 'ru', 'de', 'mobile-de', 'fr', 'mobile-fr', 'es', 'mobile-es', 'it', 'mobile-it', 'br', 'mobile-br', 'au', 'mobile-au', 'bing-us', 'ar', 'be', 'ch', 'dk', 'mobile-dk', 'fi', 'hk', 'ie', 'il', 'mobile-il', 'mx', 'mobile-mx', 'nl', 'mobile-nl', 'no', 'pl', 'se', 'mobile-se', 'sg', 'tr', 'mobile-tr', 'jp', 'in', 'mobile-in', 'hu', 'mobile-us'. | |
| Hs | Whether or not a report's line returns historical data. Possible values: '0', '1'. | |
| type | Backlink type. Possible values: 'nofollow', 'frame', 'form', 'image'. | |
| zone | Backlink TLD zone. | |
| Br |
Branded keywords. Possible values:'0', '1', '3'. '0': Not Branded '1': Branded for other domain '3': Branded |
Show all
Operations
<operation> can be set depending on the field type.
For metric fields
| Value | Description | |
|---|---|---|
| Eq | Equals | |
| Gt | Greater than | |
| Lt | Less than |
For text fields
| Value | Description | |
|---|---|---|
| Bw | Starts with | |
| Ew | Ends with | |
| Eq | Exactly matching | |
| Co | Containing | |
| Wm | Word matching |
Show all
For fields with fixed values
Leave the field blank.
SERP Features
| Code | Name | Linking to domain | Description |
|---|---|---|---|
| 0 | Instant answer | No | A direct answer to a user's search query that is usually displayed at the top of organic search results in the form of a gray-bordered box. |
| 1 | Knowledge panel | Yes | A block with brief information related to a searched topic that appears to the right of organic search results. |
| 2 | Carousel | No | A row of horizontally scrollable images displayed at the top of search results. |
| 3 | Local pack | Yes | A map with three local results that appears at the top of organic search results for a local search query. |
| 4 | Top stories | Yes | A card-style snippet presenting up to three news-related results relevant to user's search query, which is usually displayed between organic search results. |
| 5 | Image pack | Yes | A collection of images related to a search query that is usually displayed between organic search results. |
| 6 | Sitelinks | Yes | A set of links to other pages of a website that is displayed under the main organic search result and for brand-related search queries. |
| 7 | Reviews | Yes | Organic search results marked with star ratings and including the number of reviews the star rating is based on. |
| 8 | Tweet | No | A card-style snippet displaying the most recent tweets related to a search query. |
| 9 | Video | Yes | Video results with a thumbnail displayed along with other organic search results. |
| 10 | Featured video | Yes | A video result to a search query that is displayed at the top of all organic search results. |
| 11 | Featured Snippet | Yes | A short answer to a user's search query with a link to the third-party website it is taken from that appears at the top of all organic search results. |
| 13 | Image | Yes | An image result with a thumbnail displayed along with other organic search results. |
| 14 | Ads top | No | A series of ads that appear at the top of the first search results page. |
| 15 | Ads bottom | No | A series of ads that appear at the bottom of the first search results page. |
| 16 | Shopping ads | No | A row of horizontally scrollable paid shopping results that appear at the top of a search results page for a brand or product search query, and include the website's name, pricing, and product image. |
| 17 | Hotels Pack | No | A block that displays hotels related to a search query. Hotel results include information on prices and rating, and allows users to check availability for certain dates. |
| 18 | Jobs search | No | A number of job listings related to a search query that appear at the top of the search results page. Job listings include the job title, the company offering the job, a site where the listing was posted, etc. |
| 19 | Featured images | No | A collection of images is usually displayed at the top of the SERP if Google considers visual results to be more relevant than text results. Only for mobile devices. |
| 20 | Video Carousel | Yes | A row of horizontally scrollable videos displayed among search results. |
| 21 | People also ask | Yes | A series of questions that may relate to a search query that appears in an expandable grid box labeled "People also ask" between search results. |
| 22 | FAQ | Yes | A list of questions related to a particular search that shows up for a particular organic search result. When clicked on, each of the questions reveals the answer. |
| 23 | Flights | No | A block that displays flights related to a search query. Flight results include information on flight dates, duration, the number of transfers and prices. Data is taken from Google Flights. |
| 24 | Find results on | Yes | A block of domains displayed above a map. |
| 25 | Recipes | Yes | A block of recipes displayed at the top of the search results page. |
| 27 | Twitter сarousel | Yes | A carousel of tweets displayed among organic search results. |
| 28 | Indented | Yes | A list of related pages from the highest organic search result. |
| 29 | News | Yes | A list of trending news displayed among organic search results. |
| 30 | Address Pack | No | A map with the most popular places displayed at the top of the search results page. |
| 31 | Application | Yes | An app from the App Store or Play Store displayed among organic search results. Only on mobile devices. |
| 32 | Events | No | A list of relevant events displayed at the top of organic search results. |
| 34 | Popular products | No | A carousel of reviewed products available for purchasing. |
| 35 | Related products | No | A carousel of related products available for purchasing. |
| 36 | Related searches | No | A list of related searches displayed among organic search results. |
| 37 | See results about | No | A list of more precise queries displayed on the right of the search results page. |
| 38 | Short videos | Yes | A block of vertical videos. Only on mobile devices. |
| 39 | Web stories | Yes | A block of vertical stories. Only on mobile devices. |
| 40 | Application list | Yes |
A list of apps displayed among organic search results. Only on mobile devices. |
| 41 | Buying guide | Yes | A block of questions about the product's features. |
| 42 | Organic carousel | Yes | A carousel with organic results at the top of the SERP. |
| 43 | Things to know | Yes | A block of the most common related questions. |
| 44 | Datasets | Yes | A list of scientific datasets. |
| 45 | Discussions and forums | Yes | A block of related discussions. |
| 46 | Explore brands | Yes | A list of related brands. |
| 47 | Questions and answers | Yes | A carousel of related questions and answers. |
| 48 | Popular stores | Yes | A list of popular related stores. |
| 49 | Refine | No | A block of related search queries with clarifying keywords. |
| 50 | People also search | No | A carousel of competitor brands and companies at the bottom of the SERP. |
| 51 | Ads middle | No | A series of ads that appear in the middle of the first search results page. |
Show all
Sortings
You can sort the response results by different parameters in ascending or descending order.
To set the sorting in an Analytics report request, include the display_sort parameter with the target sorting rule. You can set only one sorting rule per request.
For example, you can sort keywords by traffic share in descending order in the Domain Organic Search Keywords request:
Set the display_sort request parameter to tr_desc
https://api.semrush.com/?type=domain_organic&key=YOUR_API_KEY&display_filter=%2B%7CPh%7CCo%7Cseo&display_limit=10&export_columns=Ph,Po,Pp,Pd,Nq,Cp,Ur,Tr,Tc,Co,Nr,Td&domain=seobook.com&display_sort=tr_desc&database=us
| Name | Description |
|---|---|
| am_asc | Sorting by changes in paid keywords in ascending order (Am) |
| am_desc | Sorting by changes in paid keywords in descending order (Am) |
| bm_asc | Sorting by changes in paid traffic in ascending order (Bm) |
| bm_desc | Sorting by changes in paid traffic in descending order (Bm) |
| cg_asc | Sorting by traffic cost in ascending order (Cg) |
| cg_desc | Sorting by traffic cost in descending order (Cg) |
| cm_asc | Sorting by changes in ads traffic price in ascending order (Cm) |
| cm_desc | Sorting by changes in ads traffic price in descending order (Cm) |
| co_asc | Sorting by competition in ascending order (Co) |
| co_desc | Sorting by competition in descending order (Co) |
| cp_asc | Sorting by CPC in ascending order (Cp) |
| cp_desc | Sorting by CPC in descending order (Cp) |
| cr_asc | Sorting by competition level in ascending order (Cr) |
| cr_desc | Sorting by competition level in descending order (Cr) |
| cv_asc | Sorting by coverage in ascending order (Cv) |
| cv_desc | Sorting by coverage in descending order (Cv) |
| dt_asc | Sorting by the date of the last update in ascending order (Ts) |
| dt_desc | Sorting by the date of the last update in descending order (Ts) |
| kd_asc | Sorting by keyword difficulty in ascending order (Kd) |
| kd_desc | Sorting by keyword difficulty in descending order (Kd) |
| np_asc | Sorting by common keywords in ascending order (Np) |
| np_desc | Sorting by common keywords in descending order (Np) |
| nq_asc | Sorting by volume in ascending order (Nq) |
| nq_desc | Sorting by volume in descending order (Nq) |
| nr_asc | Sorting by the number of results in ascending order (Nr) |
| nr_desc | Sorting by the number of results in descending order (Nr) |
| om_asc | Sorting by changes in organic keywords in ascending order (Om) |
| om_desc | Sorting by changes in organic keywords in descending order (Om) |
| p0_asc | Sorting by a position of the 1st domain in ascending order (P0) |
| p0_desc | Sorting by a position of the 1st domain in descending order (P0) |
| p1_asc | Sorting by a position of the 2nd domain in ascending order (P1) |
| p1_desc | Sorting by a position of the 2nd domain in descending order (P1) |
| p2_asc | Sorting by a position of the 3rd domain in ascending order (P2) |
| p2_desc | Sorting by a position of the 3rd domain in descending order (P2) |
| p3_asc | Sorting by a position of the 4th domain in ascending order (P3) |
| p3_desc | Sorting by a position of the 4th domain in descending order (P3) |
| p4_asc | Sorting by a position of the 5th domain in ascending order (P4) |
| p4_desc | Sorting by a position of the 5th domain in descending order (P4) |
| pc_asc | Sorting by number of keywords in ascending order (Pc) |
| pc_desc | Sorting by number of keywords in descending order (Pc) |
| po_asc | Sorting by a position in ascending order (Po) |
| po_desc | Sorting by a position in descending order (Po) |
| pr_asc | Sorting by price in ascending order (Pr) |
| pr_desc | Sorting by price in descending order (Pr) |
| scm_asc | Sorting by changes in the organic traffic cost driven by SERP Feature positions in ascending order (Scm) |
| scm_desc | Sorting by changes in the organic traffic cost driven by SERP Feature positions in descending order (Scm) |
| srm_asc | Sorting by changes in the number of keywords with SERP Feature positions in ascending order (Srm) |
| srm_desc | Sorting by changes in the number of keywords with SERP Feature positions in descending order (Srm) |
| stm_asc | Sorting by changes in the traffic driven by SERP Feature postions in ascending order (Stm) |
| stm_desc | Sorting by changes in the traffic driven by SERP Feature postions in descending order (Stm) |
| tc_asc | Sorting by traffic cost share in ascending order (Tc) |
| tc_desc | Sorting by traffic cost share in descending order (Tc) |
| tg_asc | Sorting by traffic in ascending order (Tg) |
| tg_desc | Sorting by traffic in descending order (Tg) |
| tm_asc | Sorting by changes in organic traffic in ascending order (Tm) |
| tm_desc | Sorting by changes in organic traffic in descending order (Tm) |
| tr_asc | Sorting by traffic share in ascending order (Tr) |
| tr_desc | Sorting by traffic share in descending order (Tr) |
| ts_asc | Sorting by timestamp in descending order (Ts) |
| ts_desc | Sorting by timestamp in descending order (Ts) |
| um_asc | Sorting by changes in organic traffic price in ascending order (Um) |
| um_desc | Sorting by changes in organic traffic price in descending order (Um) |
| last_seen_asc | Sorting by the last-seen date in ascending order (last_seen) |
| last_seen_desc | Sorting by the last-seen date in descending order (last_seen) |
| first_seen_asc | Sorting by the first-seen date in ascending order (first_seen) |
| first_seen_desc | Sorting by the first-seen date in descending order (first_seen) |
| times_seen_asc | Sorting by the number of times seen in ascending order (times_seen) |
| times_seen_desc | Sorting by the number of times seen in descending order (times_seen) |
| ads_count_asc | Sorting by the number of display ads in ascending order (ads_count) |
| ads_count_desc | Sorting by the number of display ads in descending order (ads_count) |
Show all