Public Semrush Connector API v2 Reference

The public API procedures use the internal procedures, that should not be used directly as they can be changed without an explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their name. Public API procedures do not have such prefix in their names.

Accounts_Countapiunits

The current API balance for a given API key

Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Accuracy

A metric that gauges the accuracy of the data presented

Parameter
<country> (optional): The country code parameter allows you to filter traffic data for a particular country. If the parameter is not specified, global data is shown by default
<device_type> (optional): The device filter. This parameter allows you to choose whether to retrieve desktop or mobile data, or both. If the parameter is not specified, data for all devices will be shown: desktop, mobile
<display_date> (optional): The date in YYYY-MM-01 format. If the display_date parameter is not specified, data is shown for the previous month by default
<export_columns> (optional): A list of required columns separated by a comma. If this parameter is not specified, all columns will be shown: target, display_date, country, device_type, accuracy
<target> (optional): A root domain. Required parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_AdvertiserLandings

Report URLs of a domain's landing pages promoted via display ads

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<device_type> (optional): This parameter shows the type of device by which statistics have been collected - a PC, tablet, or smartphone: all, desktop, smartphone_apple, smartphone_android, tablet_apple, tablet_android
<display_filter> (optional): Filters for columns
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: target_url, first_seen, last_seen, times_seen, ads_count
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_AdvertiserPublisherTextAds

Report the display ads of a given advertiser that have appeared on a particular publisher's website

Parameter
<publisher_domain> (required): A unique name of a website you'd like to investigate
<advertiser_domain> (required): A unique name of a website you'd like to investigate
<device_type> (optional): This parameter shows the type of device by which statistics have been collected - a PC, tablet, or smartphone: all, desktop, smartphone_apple, smartphone_android, tablet_apple, tablet_android
<display_filter> (optional): Filters for columns: ad, title, text, url
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: title, text, first_seen, last_seen, times_seen, visible_url
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_AdvertiserPublishers

Report publisher's websites where an advertiser's display ads have appeared

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<device_type> (optional): This parameter shows the type of device by which statistics have been collected - a PC, tablet, or smartphone: all, desktop, smartphone_apple, smartphone_android, tablet_apple, tablet_android
<display_filter> (optional): Filters for columns
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: domain, ads_count, first_seen, last_seen, times_seen
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_AdvertiserRank

Report advertisers ranked by the total number of display ads noticed by SEMrush

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<device_type> (optional): This parameter shows the type of device by which statistics have been collected - a PC, tablet, or smartphone: all, desktop, smartphone_apple, smartphone_android, tablet_apple, tablet_android
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: domain, ads_overall, text_ads_overall, media_ads_overall, first_seen, last_seen, times_seen, domain_overall
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_AdvertiserTextAds

Report display ads of a queried advertiser's website

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<device_type> (optional): This parameter shows the type of device by which statistics have been collected - a PC, tablet, or smartphone: all, desktop, smartphone_apple, smartphone_android, tablet_apple, tablet_android
<display_filter> (optional): Filters for columns: ad, title, text, url
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: title, text, first_seen, last_seen, times_seen, visible_url
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_AudienceInsights

Report target audience

Parameter
<country> (optional): The country code parameter allows you to filter traffic data for a particular country. If the parameter is not specified, global data is shown by default
<device_type> (optional): The device filter. This parameter allows you to choose whether to retrieve desktop or mobile data, or both. If the parameter is not specified, data for all devices will be shown: desktop, mobile
<display_date> (optional): The date in YYYY-MM-01 format. If the display_date parameter is not specified, data is shown for the previous month by default
<display_limit> (optional): The number of results returned. If this parameter is not specified, the default value will be 1000. The available range is between 1 and 5000
<export_columns> (optional): A list of required columns separated by a comma. If this parameter is not specified, all columns will be shown: target, overlap_score, similarity_score, target_users, overlap_users, categories, is_adult
<segment> (optional): An operator that regulates a relationship between targets and selected_targets: contains, excludes, shares
<selected_targets> (optional): A pick from the targets you apply a segment operator to: domain1.com,domain2.com
<targets> (optional): CSV list of domains separated by a comma. Required parameter. The maximum number of domains is limited to 5: domain1.com,domain2.com,domain3.com
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Backlinks

Report backlinks for a domain, root domain, or URL

Parameter
<target_type> (required): A type of requested target: root_domain, domain or url
<target> (required): A root domain, domain or URL address: example.com, www.example.com or http://www.example.com
<display_filter> (optional): Filters for columns. Attention. Unfortunately, at the moment you can't use filter urlanchor for domains with a large backlink profile: type, zone, ip, refdomain, anchor, newlink, lostlink, urlanchor, redirects
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas: page_ascore, response_code, source_size, external_num, internal_num, redirect_url, source_url, source_title, image_url, target_url, target_title, anchor, image_alt, last_seen, first_seen, nofollow, form, frame, image, sitewide, newlink, lostlink
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksAnchors

Report anchor texts used in backlinks leading to the queried domain, root domain, or URL. It also includes the number of backlinks and referring domains per anchor

Parameter
<target_type> (required): A type of requested target: root_domain, domain or url
<target> (required): A root domain, domain or URL address: example.com, www.example.com or http://www.example.com
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas: anchor, domains_num, backlinks_num, first_seen, last_seen
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksAscoreProfile

This report returns distribution of referring domains by Authority Score. When you run a query for a domain, in return, for each Authority Score value from 0 to 100, you receive a number of domains that have at least one link, pointing to queried domain

Parameter
<target_type> (required): Must be root_domain
<target> (required): Must be a root domain
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksCategories

This report returns the list of categories queried domain belong to. When you run a query for a domain, in return, in each line, you receive a category and a rating. Rating is a level of confidence that this domain belongs to this category (ranged from 0 to 1). Results are sorted by the rating

Parameter
<target_type> (required): Must be root_domain
<target> (required): Must be a root domain
<export_columns> (optional): Required columns must be separated by commas. rating - A level of confidence that domain specified in target field belongs to this category (ranges from 0 to 1): category_name, rating
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksCategoriesProfile

This report returns the list of categories that referring domains belong to. When you run a query for a domain, in return, in each line, you receive a category and a number of domains that have at least one link, pointing to queried domain, that have such category. Results are sorted by a number of referring domains in descending order. This report is generated, based on the first 10,000 referring domains for given queried domain

Parameter
<target_type> (required): Must be root_domain
<target> (required): Must be a root domain
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas. rating - Number of domains that belong to the corresponding category and have at least one link, pointing to domain specified in target field: category_name, rating
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksComparison

Compare your and your competitors' backlink profiles and link-building progress

Parameter
<targets> (required): CSV list of items, where an item is a root domain, domain or URL. The maximum number of targets is limited to 200
<target_types> (required): CSV list of items, where an item is a type of requested target specified in the parameter "targets"
<export_columns> (optional): Required columns must be separated by commas: target, target_type, ascore, backlinks_num, domains_num, ips_num, follows_num, nofollows_num, texts_num, images_num, forms_num, frames_num
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksCompetitors

Report domains with a similar backlink profile to the analyzed domain

Parameter
<target_type> (required): A type of requested target: root_domain, domain or url
<target> (required): A root domain, domain or URL address: example.com, www.example.com or http://www.example.com
<display_limit> (optional): The number of results returned to a request. The default and maximum value is 100. If this parameter is not specified or more than 100, the default value will be 100 lines. Display_offset parameter may be used to get more than a 100 results
<export_columns> (optional): Required columns must be separated by commas: ascore, neighbour, similarity, common_refdomains, domains_num, backlinks_num
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksGeo

Referring domain distributions by country (an IP address defines a country)

Parameter
<target_type> (required): A type of requested target: root_domain, domain or url
<target> (required): A root domain, domain or URL address: example.com, www.example.com or http://www.example.com
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas: country, domains_num, backlinks_num
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksHistorical

This report returns only monthly historical trends of number of backlinks and referring domains for queried domain. When you run a query for a domain, in return, in each line, you receive a date and a number of backlinks and referring domains queried domain had on this date. Results are sorted by date in descending order (from most recent to oldest)

Parameter
<target_type> (required): Must be root_domain
<target> (required): Must be a root domain
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas: date, backlinks_num, domains_num
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksMatrix

This report shows how many backlinks are sent to you and your competitors from the same referring domains

Parameter
<targets> (required): CSV list of items, where an item is a root domain, domain or URL
<target_types> (required): CSV list of items, where an item is a type of requested target specified in the parameter "targets"
<display_filter> (optional): Filters for columns: backlinksnum_0, backlinksnum_1, backlinksnum_2, backlinksnum_3, backlinksnum_4, backlinksnum_5
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas: domain, domain_ascore, matches_num, backlinks_num
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksOverview

Report summary of backlinks, including their type, referring domains and IP addresses for a domain, root domain, or URL

Parameter
<target_type> (required): A type of requested target: root_domain, domain or url
<target> (required): A root domain, domain or URL address: example.com, www.example.com or http://www.example.com
<export_columns> (optional): Required columns must be separated by commas: ascore, total, domains_num, urls_num, ips_num, ipclassc_num, follows_num, nofollows_num, sponsored_num, ugc_num, texts_num, images_num, forms_num, frames_num
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksPages

Indexed pages of the queried domain

Parameter
<target_type> (required): A type of requested target: root_domain, domain or url
<target> (required): A root domain, domain or URL address: example.com, www.example.com or http://www.example.com
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas: source_url, source_title, response_code, backlinks_num, domains_num, last_seen, external_num, internal_num
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksRefdomains

Report domains pointing to the queried domain, root domain, or URL

Parameter
<target_type> (required): A type of requested target: root_domain, domain or url
<target> (required): A root domain, domain or URL address: example.com, www.example.com or http://www.example.com
<display_filter> (optional): Filters for columns: zone, country, ip, newdomain, lostdomain, category
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas: domain_ascore, domain, backlinks_num, ip, country, first_seen, last_seen
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksRefips

Report IP addresses where backlinks to a domain, root domain, or URL are coming from

Parameter
<target_type> (required): A type of requested target: root_domain, domain or url
<target> (required): A root domain, domain or URL address: example.com, www.example.com or http://www.example.com
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas: ip, country, domains_num, backlinks_num, first_seen, last_seen
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_BacklinksTld

Referring domain distributions depending on their top-level domain type

Parameter
<target_type> (required): A type of requested target: root_domain, domain or url
<target> (required): A root domain, domain or URL address: example.com, www.example.com or http://www.example.com
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas: zone, domains_num, backlinks_num
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Destinations

Report sites visited by users after leaving the analyzed domain

Parameter
<country> (optional): The country code parameter allows you to filter traffic data for a particular country. If the parameter is not specified, global data is shown by default
<device_type> (optional): The device filter. This parameter allows you to choose whether to retrieve desktop or mobile data, or both. If the parameter is not specified, data for all devices will be shown: desktop, mobile
<display_date> (optional): The date in YYYY-MM-01 format. If the display_date parameter is not specified, data is shown for the previous month by default
<display_limit> (optional): The number of results returned. If this parameter is not specified, the default value will be 1000. The available range is between 1 and 5000
<export_columns> (optional): A list of required columns separated by a comma. If this parameter is not specified, all columns will be shown: target, display_date, country, device_type, to_target, traffic_share, traffic, prev_traffic, categories
<sort_order> (optional): A sort by parameter. For descending order append _desc, for ascending order append _asc. If this parameter is not specified, descending order will be set by default: traffic, traffic_diff, traffic_share
<target> (optional): A root domain. Required parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainAdwords

Report keywords that bring users to a domain via Google's paid search results

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_filter> (optional): Filters for columns: Ph, Po, Nq, Cp, Ur, Tg, Tr, Tc, Nr, Co, Pp, Pd, Un
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<display_positions> (optional): The value new indicates keywords with which a domain entered Google's top 100 organic or paid search results; lost indicates keywords that no longer bring a domain to Google's top 100 organic or paid search results; rise indicates keywords that helped a domain to get a higher ranking in Google's top 100 organic or paid search results; fall indicates keywords that are currently helping a domain remain in the Google top 100, though its ranking may have decreased: new, lost, rise or fall
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Po, Pp, Pd, Ab, Nq, Cp, Tg, Tr, Tc, Co, Nr, Td, Tt, Ds, Vu, Ur, Ts, Un
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainAdwordsAdwords

Report domain's competitors in paid search results

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dn, Cr, Np, Ad, At, Ac, Or
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainAdwordsHistorical

Keywords a domain has bid on in the last 12 months and its positions in paid search results

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_filter> (optional): Filters for columns: Ph, Nq, Cp, Tr
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Dt, Po, Cp, Nq, Tr, Ur, Tt, Ds, Vu, Cv
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainAdwordsUnique

Unique ad copies SEMrush noticed when the domain ranked in Google's paid search results for keywords from our databases

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_filter> (optional): Filters for columns: Tt, Ds, Vu
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph,Un,Tt,Ds,Vu,Ur,Pc,Ts
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainDomains

Report to compare up to five domains by common keywords, unique keywords, all keywords, or search terms that are unique to the first domain

Parameter
<domains> (required): A URL-encoded string that contains domains in a specified format, separated by | . This format requires a domain to consist of sign | type | domain , where the sign means possible operations: + , - , * , / ; type has to take the value of or for organic keywords or ad for paid keywords; and domain indicates a domain
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_filter> (optional): Filters for columns: Ph, P0, P1, P2, P3, P4, Nq, Cp, Co, Nr
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, P0, P1, P2, P3, P4, Nr, Cp, Nq, Kd, Co, Td
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainOrganic

Report keywords that bring users to a domain via Google's top 100 organic search results

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_daily> (optional): This parameter allows you to get daily updates on position changes that occurred in the last 30 days or more. If the parameter is not specified, your report will show monthly results for the current month and for previous months.This option is applied only when display_positions is set
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_filter> (optional): Filters for columns: Ph, Po, Nq, Cp, Ur, Tg, Tr, Tc, Nr, Co, Pp, Pd, Fp, Fk
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<display_positions> (optional): The value new indicates keywords with which a domain entered Google's top 100 organic or paid search results; lost indicates keywords that no longer bring a domain to Google's top 100 organic or paid search results; rise indicates keywords that helped a domain to get a higher ranking in Google's top 100 organic or paid search results; fall indicates keywords that are currently helping a domain remain in the Google top 100, though its ranking may have decreased: new, lost, rise or fall
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Po, Pp, Pd, Nq, Cp, Ur, Tr, Tg, Tc, Co, Nr, Td, Kd, Fp, Fk, Ts
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainOrganicOrganic

Report domain's competitors in organic search results

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dn, Cr, Np, Or, Ot, Oc, Ad
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainOrganicSubdomains

Subdomains of the analyzed domain ranking in Google's top 100 organic search results

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ur, Pc, Tg, Tr
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainOrganicUnique

Unique pages of the analyzed domain ranking in Google's top 100 results organic search results

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_filter> (optional): Filters for columns: Ur, Pc, Tg, Tr
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ur, Pc, Tg, Tr
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainRank

Report live or historical data on a domain's keyword rankings in both organic and paid search in a chosen regional database

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dn, Rk, Or, Xn, Ot, Oc, Ad, At, Ac, FKn, FPn
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainRankHistory

Report live and historical data on a domain's keyword rankings in both organic and paid search in a chosen database

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_daily> (optional): This parameter allows you to get daily updates on position changes that occurred in the last 30 days or more. If the parameter is not specified, your report will show monthly results for the current month and for previous months
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Rk, Or, Xn, Ot, Oc, Ad, At, Ac, Dt, FKn, FPn
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainRanks

Report live or historical data on a domain's keyword rankings in both organic and paid search in all regional databases

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (optional): A regional database; if this parameter is not specified, your request will be sent to all regional databases
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Db, Dt, Dn, Rk, Or, Ot, Oc, Ad, At, Ac, Sh, Sv, FKn, FPn
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainShopping

Report keywords that trigger a domain's product listing ads to appear in Google's paid search results

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_filter> (optional): Filters for columns: Ph,Po,Nq,Ur,Tt,Pr
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph,Po,Pp,Pd,Nq,Sn,Ur,Tt,Pr,Ts
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainShoppingShopping

Report domains a queried domain is competing against in Google's paid search results with product listing ads

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dn,Cr,Np,Sh,Ad,At,Ac,Or
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_DomainShoppingUnique

Product listing ad copies SEMrush noticed when the domain ranked in Google's paid search results for keywords from our databases

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_filter> (optional): Filters for columns: Tt,Pr
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Tt,Pr,Ur,Pc,Un,Ts
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Geo

Report countries where the visitors of the analyzed domain come from

Parameter
<device_type> (optional): The device filter. This parameter allows you to choose whether to retrieve desktop or mobile data, or both. If the parameter is not specified, data for all devices will be shown: desktop, mobile
<display_date> (optional): The date in YYYY-MM-01 format. If the display_date parameter is not specified, data is shown for the previous month by default
<display_limit> (optional): The number of results returned. If this parameter is not specified, the default value will be 1000. The available range is between 1 and 5000
<export_columns> (optional): A list of required columns separated by a comma. If this parameter is not specified, all columns will be shown: target, display_date, device_type, geo, traffic, global_traffic, traffic_share, users, avg_visit_duration, bounce_rate, pages_per_visit, desktop_share, mobile_share
<geo_type> (optional): A type of geographical coverage. If this parameter is not specified, country data is shown by default: country, subcontinent, continent
<sort_order> (optional): A sort by parameter. For descending order append _desc, for ascending order append _asc. If this parameter is not specified, descending order will be set by default: traffic, traffic_share, desktop_share, mobile_share, avg_visit_duration, pages_per_visit, bounce_rate
<target> (optional): A root domain. Required parameter
<target_type> (optional): The target domain type: domain, subdomain
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseAdwords

Report domains that are ranking in Google's paid search results with a requested keyword

Parameter
<phrase> (required): A keyword or keyword expression you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dn, Ur, Vu
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseAdwordsHistorical

Domains that have bid on a requested keyword in the last 12 months and their positions in paid search results

Parameter
<phrase> (required): A keyword or keyword expression you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dn, Dt, Po, Ur, Tt, Ds, Vu, At, Ac, Ad
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseAll

Report summary of a keyword, including its volume, CPC, competition, and the number of results in all regional databases

Parameter
<phrase> (required): A keyword or keyword expression you'd like to investigate
<database> (optional): A regional database; if this parameter is not specified, your request will be sent to all regional databases
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dt, Db, Ph, Nq, Cp, Co, Nr
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseFullsearch

Report broad matches and alternate search queries, including particular keywords or keyword expressions

Parameter
<phrase> (required): A keyword or keyword expression you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_filter> (optional): Filters for columns: Ph, Nq, Cp, Co, Nr, Wc, Fk
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Nq, Cp, Co, Nr, Td, Fk
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseKdi

Report keyword difficulty, an index that helps to estimate how difficult it would be to seize competitors' positions in organic search within the Google's top 100 with an indicated search term

Parameter
<phrase> (required): Phrase (from 1 to 100 keywords separated by semicolons)
<database> (required): A regional database (one value from the list)
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Kd
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseOrganic

Report domains that are ranking in Google's top 100 organic search results with a requested keyword

Parameter
<phrase> (required): A keyword or keyword expression you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dn, Ur, Fk, Fp
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseQuestions

Report phrase questions relevant to a queried term in a chosen database

Parameter
<phrase> (required): A keyword or keyword expression you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_filter> (optional): Filters for columns: Ph, Nq, Cp, Co, Nr
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Nq, Cp, Co, Nr, Td
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseRelated

Report an extended list of related keywords, synonyms, and variations relevant to a queried term in a chosen database

Parameter
<phrase> (required): A keyword or keyword expression you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_filter> (optional): Filters for columns: Ph, Nq, Cp, Co, Nr, Wc, Fk
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Nq, Cp, Co, Nr, Td, Rr, Fk
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseThese

Report summary of up to 100 keywords, including its volume, CPC, competition, and the number of results in a chosen regional database

Parameter
<phrase> (required): A keyword or keyword expression you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Nq, Cp, Co, Nr, Td
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PhraseThis

Report summary of a keyword, including its volume, CPC, competition, and the number of results in a chosen regional database

Parameter
<phrase> (required): A keyword or keyword expression you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Nq, Cp, Co, Nr, Td
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PublisherAdvertisers

Report advertisers whose display ads have appeared on a queried publisher's website

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<device_type> (optional): This parameter shows the type of device by which statistics have been collected - a PC, tablet, or smartphone: all, desktop, smartphone_apple, smartphone_android, tablet_apple, tablet_android
<display_filter> (optional): Filters for columns
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: domain, ads_count, first_seen, last_seen, times_seen
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PublisherRank

Report publishers ranked by the total number of display ads noticed by SEMrush

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<device_type> (optional): This parameter shows the type of device by which statistics have been collected - a PC, tablet, or smartphone: all, desktop, smartphone_apple, smartphone_android, tablet_apple, tablet_android
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: domain, ads_overall, text_ads_overall, media_ads_overall, first_seen, last_seen, times_seen, domain_overall
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_PublisherTextAds

Report display ads that have appeared on a publisher's website

Parameter
<domain> (required): A unique name of a website you'd like to investigate
<device_type> (optional): This parameter shows the type of device by which statistics have been collected - a PC, tablet, or smartphone: all, desktop, smartphone_apple, smartphone_android, tablet_apple, tablet_android
<display_filter> (optional): Filters for columns: ad, title, text, url
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: title, text, first_seen, last_seen, times_seen, visible_url
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Rank

Report the most popular domains ranked by traffic originating from Google's top 100 organic search results

Parameter
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dn, Rk, Or, Ot, Oc, Ad, At, Ac
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_RankDifference

Changes in the number of keywords, traffic, and budget estimates of the most popular websites in Google's top 100 and paid search results

Parameter
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Dn, Rk, Or, Ot, Oc, Ad, At, Ac, Om, Tm, Um, Am, Bm, Cm
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Rank_1

Report domains sorted by organic traffic in descending order

Parameter
<country> (optional): The country code parameter allows you to filter traffic data for a particular country. If the parameter is not specified, global data is shown by default
<device_type> (optional): The device filter. This parameter allows you to choose whether to retrieve desktop or mobile data, or both. If the parameter is not specified, data for all devices will be shown: desktop, mobile
<display_date> (optional): The date in YYYY-MM-01 format. If the display_date parameter is not specified, data is shown for the previous month by default
<display_limit> (optional): The number of results returned. If this parameter is not specified, the default value will be 200. The available range is between 1 and 200
<export_columns> (optional): A list of required columns separated by a comma. If this parameter is not specified, all columns will be shown: display_date, country, device_type, rank, domain, visits, users, desktop_share, mobile_share, desktop_visits, mobile_visits, time_on_site, bounce_rate, pages_per_visit
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Sources

Report to monitor traffic that comes to the analyzed domain from different sources over time. This helps you quickly and easily see which sources are generating the most traffic for the analyzed domain

Parameter
<country> (optional): The country code parameter allows you to filter traffic data for a particular country. If the parameter is not specified, global data is shown by default
<device_type> (optional): The device filter. This parameter allows you to choose whether to retrieve desktop or mobile data, or both. If the parameter is not specified, data for all devices will be shown: desktop, mobile
<display_date> (optional): The date in YYYY-MM-01 format. If the display_date parameter is not specified, data is shown for the previous month by default
<display_limit> (optional): The number of results returned. If this parameter is not specified, the default value will be 1000. The available range is between 0 and 5000
<export_columns> (optional): A list of required columns separated by a comma. If this parameter is not specified, all columns will be shown: target, from_target, display_date, country, device_type, traffic_share, traffic_diff, traffic, channel, traffic_type, search_engine, prev_traffic, categories
<sort_order> (optional): A sort by parameter. For descending order append _desc, for ascending order append _asc. If this parameter is not specified, descending order will be set by default: traffic, traffic_diff, traffic_share
<target> (optional): A root domain. Required parameter
<traffic_channel> (optional): The traffic channel type filter. This parameter allows you to filter traffic sources by a specific channel type. If this parameter is not specified, no data will be shown: direct, referral, search, social
<traffic_type> (optional): The traffic type filter. This parameter allows you to retrieve organic or paid traffic. If the traffic type is not specified, no data will be shown: organic, paid
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Subdomains

The top subdomains of an analyzed domain getting the most traffic

Parameter
<country> (optional): The country code parameter allows you to filter traffic data for a particular country. If the parameter is not specified, global data is shown by default
<device_type> (optional): The device filter. This parameter allows you to choose whether to retrieve desktop or mobile data, or both. If the parameter is not specified, data for all devices will be shown: desktop, mobile
<display_date> (optional): The date in YYYY-MM-01 format. If the display_date parameter is not specified, data is shown for the previous month by default
<display_limit> (optional): The number of results returned. If this parameter is not specified, the default value will be 1000. The available range is between 1 and 5000
<export_columns> (optional): A list of required columns separated by a comma. If this parameter is not specified, all columns will be shown: domain, display_date, country, device_type, target_type, subdomain, traffic_share, desktop_share, mobile_share, total_hits, desktop_hits, mobile_hits, total_visits, desktop_visits, mobile_visits, total_users, desktop_users, mobile_users
<sort_order> (optional): A sort by parameter. For descending order append _desc, for ascending order append _asc. If this parameter is not specified, descending order will be set by default: traffic, desktop_share, mobile_share
<target> (optional): A root domain. Required parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Summary

Report main estimated traffic metrics for multiple domains on a monthly basis for desktop and mobile users in CSV format. To gain insights on your markets, prospects or partners, enter your target domain, use filters and get key traffic data: traffic rank, visits, unique visitors, pages per visit, avg. visit duration, and bounce rate

Parameter
<country> (optional): The country code parameter allows you to filter traffic data for a particular country. If the parameter is not specified, global data is shown by default
<device_type> (optional): The device filter. This parameter allows you to choose whether to retrieve desktop or mobile data, or both. If the parameter is not specified, data for all devices will be shown: desktop, mobile
<display_date> (optional): The date in YYYY-MM-01 format. If the display_date parameter is not specified, data is shown for the previous month by default
<export_columns> (optional): A list of required columns separated by a comma. If this parameter is not specified, all columns will be shown: display_date, country, device_type, target, rank, accuracy, visits, desktop_visits, mobile_visits, users, desktop_users, mobile_users, desktop_hits, mobile_hits, direct, referral, social, search, paid, unknown_channel, time_on_site, desktop_time_on_site, mobile_time_on_site, pages_per_visit, desktop_pages_per_visit, mobile_pages_per_visit, bounce_rate, desktop_bounce_rate, mobile_bounce_rate, desktop_share, mobile_share
<targets> (optional): CSV list of both domains and subdomains separated by a comma. Required parameter. The maximum number of targets is limited to 200: example1.com,example2.com,subdomain.example3.com
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_Toppages

You what pages of an analyzed domain are the most popular among users, as well as what backlinks lead users to that domain

Parameter
<country> (optional): The country code parameter allows you to filter traffic data for a particular country. If the parameter is not specified, global data is shown by default
<device_type> (optional): The device filter. This parameter allows you to choose whether to retrieve desktop or mobile data, or both. If the parameter is not specified, data for all devices will be shown: desktop
<display_date> (optional): The date in YYYY-MM-01 format. If the display_date parameter is not specified, data is shown for the previous month by default
<display_limit> (optional): The number of results returned. If this parameter is not specified, the default value will be 1000. The available range is between 1 and 5000
<export_columns> (optional): A list of required columns separated by a comma. If this parameter is not specified, all columns will be shown: target, device_type, country, display_date, page, desktop_share, mobile_share, users_by_target, traffic, entrance_traffic, direct, search, referral, social, paid, unknown
<target> (optional): A root domain. Required parameter
<target_type> (optional): The target domain type: domain, subdomain
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_UrlAdwords

Report keywords that bring users to a URL via Google's paid search results

Parameter
<url> (required): The URL of a landing page you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_filter> (optional): Filters for columns: Ph, Po, Nq, Cp, Ur, Tg, Tr, Tc, Nr, Co, Pp, Pd
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Po, Nq, Cp, Co, Tg, Tr, Tc, Nr, Td, Tt, Ds, Ts
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Analytics_UrlOrganic

Report keywords that bring users to a URL via Google's top 100 organic search results

Parameter
<url> (required): The URL of a landing page you'd like to investigate
<database> (required): A regional database (one value from the list)
<display_date> (optional): A date on which a report will be shown. You can roll back to the past or choose an actual date
<display_filter> (optional): Filters for columns: Ph, Po, Nq, Cp, Ur, Tg, Tr, Tc, Nr, Co, Pp, Pd, Fp, Fk
<display_limit> (optional): The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines
<export_columns> (optional): Required columns must be separated by commas; if this parameter is not specified, default columns will be sent: Ph, Po, Pp, Nq, Cp, Co, Kd, Tr, Tg, Tc, Nr, Td, Fp, Fk, Ts
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects

List of all projects, including their ID, project name and domain name, as well as tools that have been activated for each project

Parameter
<project_id> (optional): Project ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_Cities

Cities within the specified country and region that a project can be set up for

Parameter
<region_id> (required): Region ID
<country_id> (required): Country ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_Countries

The countries a project can be set up for

Parameter
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_Regions

Regions within the specified country that a project can be set up for

Parameter
<country_id> (required): Country ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_SiteauditCampaignHistory

Audits' results for a selected period

Parameter
<project_id> (optional): Project ID
<offset> (required): offset
<limit> (required): limit
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_SiteauditCampaignInfo

Overview of the last audit, including the number of found issues errors, warnings, and notices, the number of passed and failed checks, the number of crawled pages and the rest of pages to crawl, and the date of the last audit, etc

Parameter
<project_id> (optional): Project ID
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_SiteauditMeta

Description of why an issue could be harmful for a website and how it can be fixed

Parameter
<project_id> (optional): Project ID
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_SiteauditPage

ID of a crawled page

Parameter
<url> (required): url for search(contains match)
<project_id> (optional): Project ID
<limit> (optional): limit data line
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_SiteauditPageInfo

Information about a page, and to get a list of its issues

Parameter
<project_id> (required): Project ID
<pageId> (required): page ID
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_SiteauditSnapshot

List of past audits' IDs, including the dates on which they were completed

Parameter
<project_id> (optional): Project ID
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_SiteauditSnapshotInfo

Overview of an audit, including the website's score, issues, its number of performed checks, etc

Parameter
<project_id> (optional): Project ID
<snapshot_id> (optional): Snaphot Id, or latest snapshot
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_SiteauditSnapshotIssue

Report description of an issue, when that issue was detected, as well as the URLs of affected pages. Works only for the last snapshot

Parameter
<snapshotId> (required): ID of the last snapshot
<project_id> (required): Project ID
<issueId> (required): Issue ID
<filter> (optional): Filters data. Add this parameter as many times as you need
<limit> (optional): Limits data. If not specified, the default value will be 10
<page> (optional): Pagination. If not specified, the default value will be 1
<sort> (optional): Sorting: index_desc, index_asc, targeturl_desc,targeturl_asc, firstseen_desc, firstseen_asc, dominteractivetime_desc, dominteractivetime_asc, samplesize_desc, samplesize_asc, tag_desc, tag_asc, code_desc, code_asc, val_desc, val_asc, count_desc, count_asc, resourcetype_desc, resourcetype_asc, info_desc, info_asc, infourl_desc, infourl_asc, item_desc, item_asc, fields_desc, fields_as
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingCampaignDates

Dates for which a campaign was harvested

Parameter
<project_id> (optional): Project ID
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingCompetitorsAdwords

Domains that appear in Google's paid search results for the keywords from a tracking campaign for the chosen location, the average position and visibility for these domains

Parameter
<url_type> (required): Type of competitors' URLs: rootdomain, subdomain, subfolder, url
<project_id> (optional): Project ID
<black_list> (optional): Exclude domains from the report output (separated by the '|' symbol)
<date_begin> (optional): Start date of the selected period
<date_end> (optional): End date of the selected period
<display_limit> (optional): The number of returned results, the default value is 10
<top_end> (optional): The bottom of the position range to search for competitors on SERP
<top_start> (optional): The top of the position range to search for competitors on SERP
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingCompetitorsOrganic

Domains that appear in Google's top 100 organic search results for the keywords from a tracking campaign for the chosen location, the average position and visibility for these domains

Parameter
<url_type> (required): Type of competitors' URLs: rootdomain, subdomain, subfolder, url
<project_id> (optional): Project ID
<black_list> (optional): Exclude domains from the report output (separated by the '|' symbol)
<business_name> (optional): The business name associated with the domain. It should match that from the Google My Business profile
<date_begin> (optional): Start date of the selected period
<date_end> (optional): End date of the selected period
<display_limit> (optional): The number of returned results, the default value is 10
<linktype_filter> (optional): Specifies whether the local pack and hotels rankings should be included in the report output or excluded from it: 0 - Include local pack and hotels rankings. This is the default value, 1 - Include only local pack and hotels rankings (organic rankings are excluded), 2 - Exclude local pack rankings, 524288 - Exclude hotels rankings, 524290 - Exclude local pack and hotels rankings
<serp_feature_filter> (optional): Filters the report output for keywords that have a specific SERP feature on SERP: fsn: Featured snippet, geo: Local pack, hot: Hotels, kng: Knowledge panel, rev: Reviews, amp: AMP, stl: Site links, vid: Video, vib: Featured video, new: Top stories, rel: People also ask, img: Images, twt: Twitter, knw: Instant answer, flg: Flights, shp: Shopping ads, adt: AdWords top, adb: AdWords bottom
<top_end> (optional): The bottom of the position range to search for competitors on SERP
<top_start> (optional): The top of the position range to search for competitors on SERP
<use_volume> (optional): Specifies the level of CPC and volume to be used in the report. If omitted, the bottom-most available level is used: national, regional, local
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingLandingPagesAdwords

This request lists all URLs from the Google paid search results that the specified domain appears in for the keywords from the tracking campaign

Parameter
<url> (required): Tracked URL or competitor URL (with mask)
<project_id> (optional): Project ID
<date_begin> (optional): Start date of the selected period
<date_end> (optional): End date of the selected period
<display_filter> (optional): Filter for columns Ph, Nq, Cp
<display_limit> (optional): The number of returned results, the default value is 10
<display_tags> (optional): Tags, separated by the '|' symbol. The '-' sign can be used to exclude a tag. If only the included tags are present in the expression, then the OR logic is used to group them. If both included and excluded tags are present, then each category is grouped using the OR logic, but then the AND logic is used to join the categories
<newlost_filter> (optional): Return only new or lost urls: new, lost
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingLandingPagesOrganic

This request lists all URLs from the Google's top 100 search results that the specified domain appears in for the keywords from the tracking campaign

Parameter
<url> (required): Tracked URL or competitor URL (with mask)
<project_id> (optional): Project ID
<date_begin> (optional): Start date of the selected period
<date_end> (optional): End date of the selected period
<display_filter> (optional): Filter for columns Ph, Nq, Cp
<display_limit> (optional): The number of returned results, the default value is 10
<display_tags> (optional): Tags, separated by the '|' symbol. The '-' sign can be used to exclude a tag. If only the included tags are present in the expression, then the OR logic is used to group them. If both included and excluded tags are present, then each category is grouped using the OR logic, but then the AND logic is used to join the categories
<linktype_filter> (optional): Specifies whether the local pack and hotels rankings should be included in the report output or excluded from it: 0 - Include local pack and hotels rankings. This is the default value, 1 - Include only local pack and hotels rankings (organic rankings are excluded), 2 - Exclude local pack rankings, 524288 - Exclude hotels rankings, 524290 - Exclude local pack and hotels rankings
<newlost_filter> (optional): Return only new or lost urls: new, lost
<use_volume> (optional): Specifies the level of CPC and volume to be used in the report. If omitted, the bottom-most available level is used: national, regional, local
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingOverviewOrganic

The number of keywords that land the specified domain on each of the top 100 positions on SERP, the number of new and lost keywords, the number of keywords with improved or decreased rankings, and the number of keywords that have changed their rankings over the selected period

Parameter
<url> (required): Tracked URL or competitor URL (with mask)
<project_id> (optional): Project ID
<business_name> (optional): The business name associated with the domain. It should match that from the Google My Business profile
<date_begin> (optional): Start date of the selected period
<date_end> (optional): End date of the selected period
<display_tags> (optional): Tags, separated by the '|' symbol. The '-' sign can be used to exclude a tag. If only the included tags are present in the expression, then the OR logic is used to group them. If both included and excluded tags are present, then each category is grouped using the OR logic, but then the AND logic is used to join the categories
<linktype_filter> (optional): Specifies whether the local pack and hotels rankings should be included in the report output or excluded from it: 0 - Include local pack and hotels rankings. This is the default value, 1 - Include only local pack and hotels rankings (organic rankings are excluded), 2 - Exclude local pack rankings, 524288 - Exclude hotels rankings, 524290 - Exclude local pack and hotels rankings
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingPositionAdwords

Keywords from a tracking campaign, the Google's paid search rankings of the specified URLs for these keywords, and position changes over the selected time period

Parameter
<url> (required): A list of encoded URLs (with mask), separated by ":"
<project_id> (optional): Project ID
<date_begin> (optional): Start date of the selected period
<date_end> (optional): End date of the selected period
<display_filter> (optional): Filter for columns Ph, Nq, Cp
<display_limit> (optional): The number of returned results, the default value is 10
<display_tags> (optional): Tags, separated by the '|' symbol. The '-' sign can be used to exclude a tag. If only the included tags are present in the expression, then the OR logic is used to group them. If both included and excluded tags are present, then each category is grouped using the OR logic, but then the AND logic is used to join the categories
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingPositionOrganic

Keywords from a tracking campaign, the Google's top 100 rankings of the specified URLs for these keywords, and position changes over the selected time period

Parameter
<url> (required): A list of encoded URLs (with mask), separated by ":"
<project_id> (optional): Project ID
<business_name> (optional): The business name associated with the domain. It should match that from the Google My Business profile
<date_begin> (optional): Start date of the selected period
<date_end> (optional): End date of the selected period
<display_filter> (optional): Filter for columns Ph, Nq, Cp
<display_limit> (optional): The number of returned results, the default value is 10
<display_tags> (optional): Tags, separated by the '|' symbol. The '-' sign can be used to exclude a tag. If only the included tags are present in the expression, then the OR logic is used to group them. If both included and excluded tags are present, then each category is grouped using the OR logic, but then the AND logic is used to join the categories
<linktype_filter> (optional): Specifies whether the local pack and hotels rankings should be included in the report output or excluded from it: 0 - Include local pack and hotels rankings. This is the default value, 1 - Include only local pack and hotels rankings (organic rankings are excluded), 2 - Exclude local pack rankings, 524288 - Exclude hotels rankings, 524290 - Exclude local pack and hotels rankings
<serp_feature_filter> (optional): Filters the report output for keywords that have a specific SERP feature on SERP: fsn: Featured snippet, geo: Local pack, hot: Hotels, kng: Knowledge panel, rev: Reviews, amp: AMP, stl: Site links, vid: Video, vib: Featured video, new: Top stories, rel: People also ask, img: Images, twt: Twitter, knw: Instant answer, flg: Flights, shp: Shopping ads, adt: AdWords top, adb: AdWords bottom
<top_filter> (optional): Positions filter: top_3, top_3_income, top_3_leave, top_3_down, top_3_up, top_1page, top_1page_income, top_1page_leave, top_1page_down, top_1page_up, top_2page, top_2page_income, top_2page_leave, top_2page_down, top_2page_up, top_100, top_100_income, top_100_leave, top_100_down, top_100_up
<use_volume> (optional): Specifies the level of CPC and volume to be used in the report. If omitted, the bottom-most available level is used: national, regional, local
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingVisibilityAdwords

A domain's visibility and visibility changes over the selected period

Parameter
<url> (required): Tracked URL or competitor URL (with mask)
<project_id> (optional): Project ID
<date_begin> (optional): Start date of the selected period
<date_end> (optional): End date of the selected period
<display_tags> (optional): Tags, separated by the '|' symbol. The '-' sign can be used to exclude a tag. If only the included tags are present in the expression, then the OR logic is used to group them. If both included and excluded tags are present, then each category is grouped using the OR logic, but then the AND logic is used to join the categories
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label

Projects_TrackingVisibilityOrganic

Domain's visibility and visibility changes over the selected period

Parameter
<url> (required): Tracked URL or competitor URL (with mask)
<project_id> (optional): Project ID
<business_name> (optional): The business name associated with the domain. It should match that from the Google My Business profile
<date_begin> (optional): Start date of the selected period
<date_end> (optional): End date of the selected period
<display_tags> (optional): Tags, separated by the '|' symbol. The '-' sign can be used to exclude a tag. If only the included tags are present in the expression, then the OR logic is used to group them. If both included and excluded tags are present, then each category is grouped using the OR logic, but then the AND logic is used to join the categories
<linktype_filter> (optional): Specifies whether the local pack and hotels rankings should be included in the report output or excluded from it: 0 - Include local pack and hotels rankings. This is the default value, 1 - Include only local pack and hotels rankings (organic rankings are excluded), 2 - Exclude local pack rankings, 524288 - Exclude hotels rankings, 524290 - Exclude local pack and hotels rankings
<serp_feature_filter> (optional): Filters the report output for keywords that have a specific SERP feature on SERP: fsn: Featured snippet, geo: Local pack, hot: Hotels, kng: Knowledge panel, rev: Reviews, amp: AMP, stl: Site links, vid: Video, vib: Featured video, new: Top stories, rel: People also ask, img: Images, twt: Twitter, knw: Instant answer, flg: Flights, shp: Shopping ads, adt: AdWords top, adb: AdWords bottom
<use_volume> (optional): Specifies the level of CPC and volume to be used in the report. If omitted, the bottom-most available level is used: national, regional, local
<projects_table> (optional): Table containing a column with project_id values
<preview> (optional): Preview only, don't write into table
<target_table> (optional): Table name to save the data to
<label> (optional): Multi-tenancy label