Class: searchmetrics

Methods

adminStatusGetListProjects(query, callback)

Get a list of projects for the current sublicense.

This call returns a complete list of all projects for the sublicense of your API key.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 1093

See:

• http://api.searchmetrics.com/api-calls/service/v1/AdminStatusGetListProjects

adminStatusGetListProjectSearchEngines(query, callback)

Lists all available search engines for a given project

Get a list of all search engines used in a project. With the IDs of the search engines you can use the ranking services to get ranking data for a specific search engine within your project.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description project_id String ID of the project that should be queried. The ID can be found in the URL when viewing the project in the Searchmetrics Suite. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 1105

See:

• http://api.searchmetrics.com/api-calls/service/v1/AdminStatusGetListProjectSearchEngines

adminStatusGetValueAvailableCredits(callback)

Returns the amount of available credits

This call returns the amount of available credits for the current period.

Parameters:

Name	Type	Description
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 1115

See:

• http://api.searchmetrics.com/api-calls/service/v1/AdminStatusGetValueAvailableCredits

projectOptimizationGetListDomainErrors(query, callback)

Site optimization: errors, warnings and notices.

This call returns a list of all identified errors, warnings and notices. The field [potential] indicates the amount that each error influences your Domain Score. Special attention should be given to errors with greater potential. Trending results are also critical – are there any errors, warnings or notices that have increased a lot since the last crawl? If so, take a closer look and dig deeper by checking the URLs. Please note: The API key for this call must be from the account that owns the queried project. API keys from invited users do not work.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description project_id String ID of the project that should be queried. The ID can be found in the URL when viewing the project in the Searchmetrics Suite. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 1068

See:

• http://api.searchmetrics.com/api-calls/service/v1/ProjectOptimizationGetListDomainErrors

projectOptimizationGetValueDomainScore(query, callback)

Get the current Optimization Domain Score with a trend for the last crawl

The Optimization Domain Score measures a project’s optimization level. Domain Score is calculated using the number of identified errors, warnings and suggestions according to the number of analyzed pages. The higher the Domain Score, the better a site is optimized. Please note: The API key for this call must be from the account that owns the queried project. API keys from invited users do not work.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description project_id String ID of the project that should be queried. The ID can be found in the URL when viewing the project in the Searchmetrics Suite. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 1080

See:

• http://api.searchmetrics.com/api-calls/service/v1/ProjectOptimizationGetValueDomainScore

projectOrganicGetListRankings(query, callback)

Keyword rankings for a project or benchmark domain in organic search results

This call returns the rankings for the monitored keywords for a domain (either a project or a benchmark domain) in the organic search results in a given country, based on the latest month available in the database. The results contain a lot of additional information (please check result description) and are orderd by estimated traffic in descending order. Please note: The API key for this call must be from the account that owns the queried project. API keys from invited users do not work.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description project_id String ID of the project that should be queried. The ID can be found in the URL when viewing the project in the Searchmetrics Suite. Format: Integer se_id String ID of the search engine that should be queried. A complete list of IDs can be found http://api.searchmetrics.com/api-calls/searchengines. Please make sure your project includes the se_id." Format: integer url String Domains within the project that should be queried. Several domains must be separated with a comma without blank. Please use the exact name that is used within the project. E.g "www.searchmetrics.com" instead of "searchmetrics.com". Format: domain1.tld,domain2.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Format: integer trend_interval String <optional> Set the time range for the trend comparisons. To compare the actual results with the last results use "last" (default). Other possible values are "weekly" (last week) and monthly (last month). Format: string
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 995

See:

• http://api.searchmetrics.com/api-calls/service/v1/ProjectOrganicGetListRankings

projectOrganicGetListRankingsFilter(query, callback)

Keyword rankings for a project or benchmark domain in organic search results with various filter options

This call returns the rankings for the monitored keywords for a domain (either a project or a benchmark domain) in the organic search results in a given country, based on a given date. The results contain a lot of additional information (please check result description), are orderd by estimated traffic in descending order and can be filtered by various options. Please note: The API key for this call must be from the account that owns the queried project. API keys from invited users do not work. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description project_id String ID of the project that should be queried. The ID can be found in the URL when viewing the project in the Searchmetrics Suite Format: integer se_id String ID of the search engine that should be queried. A complete list of IDs can be found http://api.searchmetrics.com/api-calls/searchengines. Please make sure your project includes the se_id. Format: integer url String Domains within the project that should be queried. Several domains must be separated with a comma without blank. Please use the exact name that is used within the project. E.g "www.searchmetrics.com" instead of "searchmetrics.com". Format: domain1.tld,domain2.tld cpc_from String <optional> Filter: Lowest estimated CPC for returned keywords. E.g. if you want all keywords with a minimum estimated CPC of 1€ visitors this parameter has to be set to "1". Format: integer cpc_to String <optional> Filter: Highest estimated CPC for returned keywords. E.g. if you want all keywords with a maximum estimated CPC of 2 this parameter has to be set to "2". Format: integer date String <optional> Date for which the rankings should be queried Format: YYYYMMDD limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer position_from String <optional> Filter: Lowest ranking of keywords that should be returned. E.g. if you want all keywords starting from the position 4 (meaning 4,5,6 etc.) this parameter has to be set to "4". Format: integer position_to String <optional> Filter: Highest ranking of keywords that should be returned. E.g. if you want all keywords up to position 3 ( resulting in all keywords with a SERP of 1, 2 or 3) this parameter has to be set to "3". Format: integer searchvolume_from String <optional> Filter: Lowest monthly search volume in Google for returned keywords. E.g. if you want all keywords with a minimum estimated search volume of 300 this parameter has to be set to "300". Format: integer searchvolume_to String <optional> Filter: Highest estimated monthly search volume for returned keywords. E.g. if you want all keywords with a maximum estimated monthly search volume of 1000 this parameter has to be set to "1000". Format: integer traffic_from String <optional> Filter: Lowest estimated traffic for returned keywords. E.g. if you want all keywords with a minimum estimated traffic of 300 visitors this parameter has to be set to "300". Format: integer traffic_to String <optional> Filter: Highest estimated monthly search volume for returned keywords. E.g. if you want all keywords with a maximum estimated monthly search volume of 1000 this parameter has to be set to "1000". Format: integer trend_interval String <optional> Set the time range for the trend comparisons. To compare the actual results with the last results use "last" (default). Other possible values are "weekly" (last week) and monthly (last month). Format: string type String <optional> Universal search type. Possible values are universal, news, maps, video, images and shopping. Format: string
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 1022

See:

• http://api.searchmetrics.com/api-calls/service/v1/ProjectOrganicGetListRankingsFilter

projectOrganicGetListRankingsHistoric(query, callback)

Historic keyword rankings for a project or benchmark domain in organic search results

This call returns the rankings for the monitored keywords for a domain (either a project or a benchmark domain) in the organic search results in a given country, based on a given date. The results contain a lot of additional information (please check result description) and are orderd by estimated traffic in descending order. Please note: The API key for this call must be from the account that owns the queried project. API keys from invited users do not work. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description project_id String ID of the project that should be queried. The ID can be found in the URL when viewing the project in the Searchmetrics Suite. Format: integer se_id String ID of the search engine that should be queried. A complete list of IDs can be found http://api.searchmetrics.com/api-calls/searchengines. Please make sure your project includes the se_id. Format: integer url String Domains within the project that should be queried. Several domains must be separated with a comma without blank. Please use the exact name that is used within the project. E.g "www.searchmetrics.com" instead of "searchmetrics.com". Format: domain1.tld,domain2.tld date String <optional> Date for which the rankings should be queried Format: YYYYMMDD limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Format: integer trend_interval String <optional> Set the time range for the trend comparisons. To compare the actual results with the last results use "last" (default). Other possible values are "weekly" (last week) and monthly (last month). Format: string
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 1040

See:

• http://api.searchmetrics.com/api-calls/service/v1/ProjectOrganicGetListRankingsHistoric

projectOrganicGetValueSeoVisibility(query, callback)

Get the SEO visibility for a project or for the tags of a project.

This call returns the Searchmetrics Visibility in the organic search for a project based on the latest data in our database. Project SEO Visibility differs from general SEO Visibility in that it uses a project’s selected keywords to evaluate visibility. It is made up of ranking keywords’ search volumes and positions. Within these figures, each position is ranked individually according to factors determined by Searchmetrics. The nature of a keyword, as either a ranking or navigational keyword, equally influences SEO visibility. Please note: The API key for this call must be from the account that owns the queried project. API keys from invited users do not work.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description project_id String ID of the project that should be queried. The ID can be found in the URL when viewing the project in the Searchmetrics Suite. Format: integer se_id String ID of the search engine that should be queried. A complete list of IDs can be found http://api.searchmetrics.com/api-calls/searchengines. Please make sure your project includes the se_id. Format: integer url String Domains within the project that should be queried. Several domains must be separated with a comma without blank. Please use the exact name that is used within the project. E.g "www.searchmetrics.com" instead of "searchmetrics.com". Format: string tags String <optional> Comma separated list of tags. Please note: When using more than one tag only keywords with both tags will be included Format: string trend_interval String <optional> Set the time range for the trend comparisons. To compare the actual results with the last results use "last" (default). Other possible values are "weekly" (last week) and "monthly" (last month). Format: string
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 1056

See:

• http://api.searchmetrics.com/api-calls/service/v1/ProjectOrganicGetValueSeoVisibility

researchKeywordsGetListKeywordinfo(query, callback)

Search volume, CPC etc. for a given keyword

This call returns search-related information for a given keyword for a given country for the current month.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries keyword String Keyword for which info should be queried. Format: string currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc.
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 304

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListKeywordinfo

researchKeywordsGetListKeywordinfoHistoric(query, callback)

Historic search volume, CPC etc. for a given keyword

This call returns search-related information for a given keyword for a given country for the specified month. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries keyword String Keyword for which info should be queried. Format: string year_month String Date Format: YYYYMM currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc.
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 319

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListKeywordinfoHistoric

researchKeywordsGetListLosers(query, callback)

Keywords with the highest absolute losses in organic search traffic for a given domain

This call returns the keywords with the biggest losses in absolute search volumes in comparison to the previous week for a given domain.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 334

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListLosers

researchKeywordsGetListLosersFilter(query, callback)

Keywords with the highest absolute losses in organic search traffic for a given domain with filter options

This call returns the keywords with the biggest losses in absolute search volumes in comparison to the previous week for a given domain for a given point in time. Please note that a certain subscription level may be needed to use this call. Several filter options are available.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries date String Date for which the winners are queried Format: YYYYMMDD url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld cpc_from String <optional> Filter: Lowest estimated CPC for returned keywords. E.g. if you want all keywords with a minimum estimated CPC of 1€ visitors this parameter has to be set to "1". Format: integer cpc_to String <optional> Filter: Highest estimated CPC for returned keywords. E.g. if you want all keywords with a maximum estimated CPC of 2 this parameter has to be set to "2". Format: integer currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc. delta_position_from String <optional> Filter: Lowest change in position of a keyword that should be returned. E.g. if you want all keywords with a change of 4 or less positions this parameter has to be set to "-4". Format: integer delta_position_to String <optional> Filter: Highest change in position of a keyword that should be returned. E.g. if you want all keywords with a change of 10 or more positions this parameter has to be set to "-10". Format: integer delta_traffic_from String <optional> Filter: Lowest change in traffic of a keyword that should be returned. E.g. if you want all keywords with a change of 50 or less visitors this parameter has to be set to "-50". Format: integer delta_traffic_to String <optional> Filter: Highest change in traffic of a keyword that should be returned. E.g. if you want all keywords with a change of 1000 or more visitors this parameter has to be set to "-1000". Format: integer limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer position_from String <optional> Filter: Lowest ranking of keywords that should be returned. E.g. if you want all keywords starting from the position 4 (meaning 4,5,6 etc.) this parameter has to be set to "4". Format: integer position_to String <optional> Filter: Highest ranking of keywords that should be returned. E.g. if you want all keywords up to position 3 ( resulting in all keywords with a SERP of 1, 2 or 3) this parameter has to be set to "3". Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 359

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListLosersFilter

researchKeywordsGetListLosersHistoric(query, callback)

Keywords with the highest absolute losses in organic search traffic for a given domain for a given date

This call returns the keywords with the biggest losses in absolute search volumes in comparison to the previous week for a given domain for a given date Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries date String Date from which the SEO Visibility losers should be queried Format: YYYYMMDD url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 375

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListLosersHistoric

researchKeywordsGetListRelatedKeywords(query, callback)

List of keywords related to a given keyword.

This call returns related keywords to a given term, meaning words that have a semantic similarity to the given term. For the given term "car" e.g. "auto" could be returned. Other additional information such as search volume and estimated CPC is returned based on the last month in our database and the given country. All listed keywords are ordered by search volume.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country as specified in ISO 3166-1 Format: US, GB, DE etc. keyword String Keyword that is used as a basis to deliver related keywords Format: string limit String <optional> Determines the number of result rows. Allowed values result are 10/25/50/100/250. Default value is 10. Format: integer offset String <optional> Offset for result set, default is 0. Has to be a multiple of allowed values for the parameter "limit". Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 390

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListRelatedKeywords

researchKeywordsGetListSimilarKeywords(query, callback)

List of keywords that contain a selected keyword.

This service returns keywords that contain a given term within a word or phrase. A result example for the given term "auto" would be "automobile" and "auto insurance" . Other additional information such as search volume and estimated CPC is returned based on the last month in our database and the given country. All listed keywords are ordered by search volume.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. keyword String keyword that is used to find similar keywords Format: string limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 25 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 405

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListSimilarKeywords

researchKeywordsGetListWinners(query, callback)

Keywords with the highest absolute gains in organic search traffic for a given domain

This call returns the keywords with the biggest gains in absolute search volumes in comparison to the previous week for a given domain.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 420

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListWinners

researchKeywordsGetListWinnersFilter(query, callback)

Keywords with the highest absolute gains in organic search traffic for a given domain with filter options

This call returns the keywords with the biggest gains in absolute search volumes in comparison to the previous week for a given domain for a given point in time. Please note that a certain subscription level may be needed to use this call. Several filter options are available.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries date String Date for which the winners are queried Format: YYYYMMDD url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld cpc_from String <optional> Filter: Lowest estimated CPC for returned keywords. E.g. if you want all keywords with a minimum estimated CPC of 1€ visitors this parameter has to be set to "1". Format: integer cpc_to String <optional> Filter: Highest estimated CPC for returned keywords. E.g. if you want all keywords with a maximum estimated CPC of 2 this parameter has to be set to "2". Format: integer currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc. delta_position_from String <optional> Filter: Lowest change in position of a keyword that should be returned. E.g. if you want all keywords with a change of 4 or more positions this parameter has to be set to "4". Format: integer delta_position_to String <optional> Filter: Highest change in position of a keyword that should be returned. E.g. if you want all keywords with a change of 10 or less positions this parameter has to be set to "10". Format: integer delta_traffic_from String <optional> Filter: Lowest change in traffic of a keyword that should be returned. E.g. if you want all keywords with a change of 50 or more visitors this parameter has to be set to "50". Format: integer delta_traffic_to String <optional> Filter: Highest change in traffic of a keyword that should be returned. E.g. if you want all keywords with a change of 1000 or less visitors this parameter has to be set to "1000". Format: integer limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer position_from String <optional> Filter: Lowest ranking of keywords that should be returned. E.g. if you want all keywords starting from the position 4 (meaning 4,5,6 etc.) this parameter has to be set to "4". Format: integer position_to String <optional> Filter: Highest ranking of keywords that should be returned. E.g. if you want all keywords up to position 3 ( resulting in all keywords with a SERP of 1, 2 or 3) this parameter has to be set to "3". Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 445

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListWinnersFilter

researchKeywordsGetListWinnersHistoric(query, callback)

Keywords with the highest absolute gains in organic search traffic for a given domain with access to historic data

This call returns the keywords with the biggest gains in absolute search volumes in comparison to the previous week for a given domain for a given point in time. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries date String Date Format: YYYYMMDD url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 461

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchKeywordsGetListWinnersHistoric

researchLinksGetCountBacklinks(query, callback)

Number of backlinks for a given domain, subdomain or URL.

This call returns the number of backlinks for a given domain, subdomain or url.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String Can be either a domain, a subdomain or a page. For a domain or a subdomain all backlinks are counted that refer to any page of the domain or subdomain. For any other URL only backlinks are counted that point directly to the specified page. Format: domain.tld, subdomain.domain.tld, domain.tld/page.html
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 649

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetCountBacklinks

researchLinksGetCountDeeplinkRatio(query, callback)

Ratio of homepage links and deeplinks for a given domain

This call returns the number of external links pointing to a the homepage and to subpages (deeplinks) of a given URL. You should keep this ratio in mind for link-building projects. It should be as ‘natural’ as possible and judged according to the ratio of your strongest competitors.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 661

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetCountDeeplinkRatio

researchLinksGetCountEduGovLinks(query, callback)

Number of links from pages with an .edu or .gov top-level domain

This call returns the total number of links from .edu and .gov domains pointing to the given URL. These links are often seen as especially strong because they come from universities and American governmental agencies.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String Either a domain, a subdomain or an URL Format: domain.tld, subdomain.domain.tld, domain.tld/page.html
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 673

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetCountEduGovLinks

researchLinksGetCountNewsDomains(query, callback)

Number of links from news sites pointing to a given URL

This call returns the current number of links from news sites as well as the number of referring news domains for a given URL. Google has high trust in news pages because editors are responsible for the setting of links. A link from a news page is therefore more valuable than a link from a web catalogue or a blog. However, all types of links are necessary for a natural link profile.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String Either a domain, a subdomain or an URL Format: domain.tld, subdomain.domain.tld, domain.tld/page.html
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 685

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetCountNewsDomains

researchLinksGetCountReferringDomains(query, callback)

Number of referring domains for a given URL (domain popularity).

This call returns the number of referring domains for a given domain, subdomain or URL. Referring domains are important to analyze to understand the strength, relevancy and diversity of a domain's backlinks. The total number of backlinks can often include many links from the same referring domain, so rather than sifting through multiple links from the same domain, an analysis of referring domains can save time and reveal issues. What do the Referring Domains show us? Referring Domains reveal backlink sources and can be compared to competitors to establish strength in the market place. Referring domains can also help webmasters ensure that backlinks are relevant to the content of the site and coming from a diversity of quality sources. This is becoming more important to the search engines as an imbalanced link profile can be a sign of spam or link sculpting, both of which will negatively impact the ranks.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String Either a domain, a subdomain or a page For a domain or a subdomain all domains are counted that refer to any page of the domain or subdomain. For any other URL only domains are counted that point directly to the page with this specific URL. Format: domain.tld, subdomain.domain.tld, domain.tld/page.html
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 697

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetCountReferringDomains

researchLinksGetCountReferringIps(query, callback)

Number of referring IPs for a given URL (IP popularity).

This call returns the number of different IPs with at least one link to the given URL (IP popularity). The IP popularity is important for Google to discover artificially constructed link networks and remove them from a site’s popularity. The call returns as well information aboutthe number of referring IPs with different C/B class. An identical C-class in the IP is another sign for a possible connection between the referring IPs, e.g. a similar hosting provider or somehow otherwise “associated” environment. A high number of IP C classes shows Google that the links are very well distributed and are therefore probably natural.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String Either a domain, a subdomain or an URL For a domain or a subdomain all results are counted that refer to any page of the domain or subdomain. For any other URL only results are counted that point directly to the page with this specific URL. Format: domain.tld, subdomain.domain.tld, domain.tld/page.html
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 709

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetCountReferringIps

researchLinksGetListBacklinks(query, callback)

Backlinks for a given URL

This call returns backlinks for a given URL including a lot of additional information. Retrieving high numbers of backlinks must eventually be done with several separate calls since the absolute number of rows per call is limited (details see below).

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description url String Either a domain, a subdomain or an URL For a domain or a subdomain all results are counted that refer to any page of the domain or subdomain. For any other URL only results are counted that point directly to the page with this specific URL. Format: domain.tld, subdomain.domain.tld, domain.tld/page.html limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 723

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetListBacklinks

researchLinksGetListLinkedPages(query, callback)

List of pages of a given URL with links from external pages

This call delivers the subpages of a given domain, subdomain or URL that are linked from external pages ordered by the number of external links. The page with the most external links is usually the homepage. However, often there are also strong subpages that can be used to distribute the link trust to other pages on the website.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description url String Either a domain, a subdomain or an URL For a domain or a subdomain all results are counted that refer to any page of the domain or subdomain. For any other URL only results are counted that point directly to the page with this specific URL. Format: domain.tld, subdomain.domain.tld, domain.tld/page.html limit String <optional> Limit for the number of returned link texts Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 737

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetListLinkedPages

researchLinksGetListLinktext(query, callback)

Most frequently used link anchor texts for a given URL.

This call returns the anchor texts of backlinks for a given URL, ordered by frequency of occurrence. A link is particularly strong when it already contains a keyword for which the linking site has a strong Google ranking. For this reason, anchor text analysis is a very important factor in ranking assessments. You should, however, be careful to make sure that anchor texts are not too similar and that the targeted keyword is not contained in every text.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description url String Either a domain, a subdomain or an URL For a domain or a subdomain all results are counted that refer to any page of the domain or subdomain. For any other URL only results are counted that point directly to the page with this specific URL. Format: domain.tld, subdomain.domain.tld, domain.tld/page.html limit String <optional> Limit for the number of returned link texts Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 751

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetListLinktext

researchLinksGetListSpsSpread(query, callback)

Distribution of incoming links according to Searchmetrics Page Strength

Get a list of the current SPS distribution for a domain, subdomain or a single URL. Searchmetrics calculates for each page the page strength from the weighted backlinks that point to this page. A page with many links is given a high Searchmetrics Page Strength (SPS); a page with no or only a few links a low SPS.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String Either a domain, a subdomain or an URL For a domain or a subdomain all results are counted that refer to any page of the domain or subdomain. For any other URL only results are counted that point directly to the page with this specific URL. Format: domain.tld, subdomain.domain.tld, domain.tld/page.html
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 763

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetListSpsSpread

researchLinksGetValueLinkRank(query, callback)

Link Rank for a given domain in a given country

This call returns the Link Rank for a given domain in a given country, indicating the strength of the selected domain’ with regard to linking in comparison with all other domains of the country in question. The more links are pointing to the domain, the better the link rank. Also the strength of the links is taken into account in the unique algorithm used to calculate the Link Rank index. In addition, the call returns the Link Rank all-time-high for for the selected domain plus an average of the Link Rank of its competitors.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description competitors String competitors of the given domain, several domains must be separated with a comma without blank. Format: domain1.tld,domain2.tld countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 777

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetValueLinkRank

researchLinksGetValuePageStrength(query, callback)

Searchmetrics Page Strength (SPS) for a given page.

This call returns the Searchmetrics Page Strength (SPS) an indicator for the value of a link from the respective page. The SPS, our version of PageRank, refers to the authority of links pointing to a domain. SPS factors in both quality and quantity of links from the referring domain based on a scale of 1 to 10, with 10 being the most authoritative. The higher the SPS, the more valuable is a link from this page.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String URL of a page Format: domain.tld/page.html
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 789

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchLinksGetValuePageStrength

researchOrganicGetCountDomainKeyword(query, callback)

Number of organic keywords for a given domain.

This call returns the number of organic keywords with a ranking in the organic search results in Google for a given domain and a given country, based on the last month available in our database.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc url String Either a domain or a subdomain Format: domain.tld, subdomain.domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 11

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetCountDomainKeyword

researchOrganicGetCountDomainKeywordFilter(query, callback)

Number of organic keywords for a given domain with filter options.

This call returns the number of organic keywords with a ranking in the organic search results in Google for a given domain and a given country and a given month. Please note that a certain subscription level may be needed to use this call. The results can be filtered by position.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries url String Either a domain or a subdomain Format: domain.tld,. subdomain.domain.tld year_month String Date Format: YYYYMM position_from String <optional> Filter: Lowest ranking of keywords that should be considered in the count. E.g. if you want to count all keywords starting from the position 4 (meaning 4,5,6 etc.) this parameter has to be set to "4". Format: 1,2,3 etc. position_to String <optional> Filter: Highest ranking of keywords that should be considered in the count. E.g. if you want to count all keywords up to position 3 ( resulting in all keywords with a SERP of 1, 2 or 3) this parameter has to be set to "3". Format: 2,3,4 etc
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 27

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetCountDomainKeywordFilter

researchOrganicGetCountDomainKeywordHistoric(query, callback)

Number of organic keywords for a given domain with access to historic data.

This call returns the number of organic keywords with a ranking in the organic search results in Google for a given domain and a given country and a given month. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries url String Either a domain or a subdomain Format: domain.tld, subdomain.domain.tld year_month String Date Format: YYYYMM
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 41

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetCountDomainKeywordHistoric

researchOrganicGetListCommonKeywords(query, callback)

Overview comparison of the most relevant shared keywords (comeptititve keywords) for two URLs in organic search results.

Get a list of the most relevant shared keywords in the organic search results for two URLs.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url_1 String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld url_2 String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 57

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListCommonKeywords

researchOrganicGetListCompetitors(query, callback)

Competitor domains in the organic search

This call returns the competitors in the organic search. A competitor is defined as a domain that shows up in the organic search results for a keyword for which the original domain has a ranking as well.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain or subdomain Format: domain.ltd, subdomain.domain.ltd currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc. limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 73

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListCompetitors

researchOrganicGetListIndustrySpread(query, callback)

Industry sector classification of a domain

Searchmetrics organizes all analyzed keywords into standard industry sectors. The Industry Spread shows the distribution of all keywords of a domain on the different industry sectors.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 86

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListIndustrySpread

researchOrganicGetListRankingsDomain(query, callback)

Keyword rankings for a given domain in organic search results.

This call returns a list keywords of a domain that had rankings in the organic search results in Google in a given country, based on the latest month available in our database. The results include a lot of additional information (please check result description) and are orderd by estimated traffic in descending order.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 101

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListRankingsDomain

researchOrganicGetListRankingsDomainFilter(query, callback)

Keyword rankings for a given domain in organic search results with filter options.

This call returns a list keywords of a domain that had rankings in the organic search results in Google in a given country, based on the latest data in our database. Please note that a certain subscription level may be needed to use this call. Additionally the results can be filtered by position, search volume and/or monthly traffic volume. The results include a lot of additional information (please check result description) and are orderd by estimated traffic in descending order.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries url String Either a domain or a subdomain Format: domain.tld, subdomain.domain.tld currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc. limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Format: integer position_from String <optional> Filter: Lowest ranking of keywords that should be returned. E.g. if you want all keywords starting from the position 4 (meaning 4,5,6 etc.) this parameter has to be set to "4". Format: string position_to String <optional> Filter: Highest ranking of keywords that should be returned. E.g. if you want all keywords up to position 3 ( resulting in all keywords with a SERP of 1, 2 or 3) this parameter has to be set to "3". Format: string search_volume_monthly_from String <optional> Filter: Lowest monthly search volume in Google for returned keywords. E.g. if you want all keywords with a minimum estimated search volume of 300 this parameter has to be set to "300". Format: integer search_volume_monthly_to String <optional> Filter: Highest estimated monthly search volume for returned keywords. E.g. if you want all keywords with a maximum estimated monthly search volume of 1000 this parameter has to be set to "1000". Format: integer traffic_monthly_from String <optional> Filter: Lowest estimated traffic for returned keywords. E.g. if you want all keywords with a minimum estimated traffic of 300 visitors this parameter has to be set to "300". Format: integer traffic_monthly_to String <optional> Filter: Highest estimated traffic for returned keywords. E.g. if you want all keywords with a maximum estimated traffic of 1000 visitors this parameter has to be set to "1000". Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 123

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListRankingsDomainFilter

researchOrganicGetListRankingsDomainHistoric(query, callback)

Historic keyword rankings for a given domain in organic search results.

This call returns a list keywords of a domain that had rankings in the organic search results in Google in a given country in a given week. Please note that a certain subscription level may be needed to use this call. The result includes a lot of additional information (please check result description) and are orderd by estimated traffic in descending order.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries date String Date Format: YYYYMMDD url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc. limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 140

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListRankingsDomainHistoric

researchOrganicGetListRankingsKeyword(query, callback)

Rankings for a given keyword in organic search results.

This call returns a list of Google's organic rankings for a given keyword, based on the latest month available in our database and ordered by position in ascending order. As well a trend in comparison to the previous month is returned.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. keyword String Keyword for which the rankings are determined Format: string limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 155

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListRankingsKeyword

researchOrganicGetListRankingsKeywordHistoric(query, callback)

Historic rankings for a given keyword in organic search results.

This call returns a list of Google's organic rankings for a given keyword, based on the latest month available in our database and ordered by position in ascending order. As well a trend in comparison to the previous month is returned. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries date String Date Format: YYYYMMDD keyword String Keyword for which the rankings are determined Format: string limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 171

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListRankingsKeywordHistoric

researchOrganicGetListSeoVisibilityHistoric(query, callback)

Searchmetrics SEO Visibility for a given URL in a given country in a given timeframe.

This call returns the Searchmetrics Visibility in the organic search for a domain for a specified country based for a given timeframe. The SEO Visibility is composed of search volume and the position of ranking keywords. Each position is individually measured by a calculated factor by Searchmetrics. Also, the SEO Visibility factors in whether the ranking keywords are navigational or informational. What does the SEO Visibility show us? The SEO Visibility presents the current trend and historical development of a domain's visibility in search engines. The index reflects how often a website shows up in the search results. While the SEO Visibility can relate to a website's real traffic, it is important to remember that traffic can come from many different places online. Therefore the SEO Visibility is only an indicator of visibility that comes from a website's organic search channel. SEO Visibility makes it possible to compare the performance of different domains in search engines. With the historical data, problems as well as positive changes can be identified. Comparing the SEO Visibility of thematically similar websites or competitors will provide the most value as developments of the market environment will be factored in and market trends easily identified. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc date_from String Start date from which the SEO Visibility should be queried Format: YYYYMMDD date_to String End date to which the SEO Visibility should be queried Format: YYYYMMDD url String Domain for which the SEO Visibility is queried Format: domain.tld, subdomain.domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 186

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListSeoVisibilityHistoric

researchOrganicGetListSeoVisibilityTop100Losers(query, callback)

Top100 Searchmetrics Organic Visibility losers in a given country

This call returns the domains with the largest absolute visibility losses for organic search results in the previous week in a given country.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc.
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 198

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListSeoVisibilityTop100Losers

researchOrganicGetListSeoVisibilityTop100Winners(query, callback)

Top100 Organic Visibility winners in a given country

This call returns the domains with the largest absolute visibility gains for organic search results in the previous week in a given country.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc.
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 210

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListSeoVisibilityTop100Winners

researchOrganicGetListSerpSpread(query, callback)

Ranking distribution of identified keywords in a given country.

This data represents the relative distribution of a site's search results (SERPs) in Google in a given country based on the latest data in our database. The rankings are split into 7 clusters: Position 1-3 Position 4-6 Position 7-10 Position 11-21 Position 21-30 Position 31-40 Position 41+ For each group, the absolute number of keywords as well as the distribution in percent is returned.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String URL for which the SEO Visibility is determined. The Visibility can be queried for a domain, a subdomain or a directory. For a domain, subdomain or directory all belonging sub-pages are included in the calculation. Format: domain.tld, subdomain.domain.tld, domain.tld/directory
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 223

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListSerpSpread

researchOrganicGetListSubdomains(query, callback)

Subdomains for one given domain

This call returns the Subdomains in the organic search. A subdomain is defined with the domain in the organic search results.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Get a domain Format: domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 238

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetListSubdomains

researchOrganicGetValueSeoRank(query, callback)

SEO Visibility rank of the domain (SEORank)

This call returns the SEO Visibility rank (SEORank) for a domain in a given country. The rank represents the position of the domain in the top 100,000 SEO Visibility list for the country. The SEO Visibility is composed of search volume and the position of ranking keywords. Each position is individually measured by a calculated factor by Searchmetrics. Also, the SEO Visibility factors in whether the ranking keywords are navigational or informational. What does the SEO Visibility show us? The SEO Visibility presents the current trend and historical development of a domain's visibility in search engines. The index reflects how often a website shows up in the search results. While the SEO Visibility can relate to a website's real traffic, it is important to remember that traffic can come from many different places online. Therefore the SEO Visibility is only an indicator of visibility that comes from a website's organic search channel. SEO Visibility makes it possible to compare the performance of different domains in search engines. With the historical data, problems as well as positive changes can be identified. Comparing the SEO Visibility of thematically similar websites or competitors will provide the most value as developments of the market environment will be factored in and market trends easily identified.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc url String Domain Format: domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 251

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetValueSeoRank

researchOrganicGetValueSeoVisibility(query, callback)

Searchmetrics SEO Visibility for a given URL in a given country.

This call returns the Searchmetrics Visibility in the organic search for a domain for a specified country based on the latest data in our database. In addition, a trend in comparision to the previous week is delivered. The SEO Visibility is composed of search volume and the position of ranking keywords. Each position is individually measured by a calculated factor by Searchmetrics. Also, the SEO Visibility factors in whether the ranking keywords are navigational or informational. What does the SEO Visibility show us? The SEO Visibility presents the current trend and historical development of a domain's visibility in search engines. The index reflects how often a website shows up in the search results. While the SEO Visibility can relate to a website's real traffic, it is important to remember that traffic can come from many different places online. Therefore the SEO Visibility is only an indicator of visibility that comes from a website's organic search channel. SEO Visibility makes it possible to compare the performance of different domains in search engines. With the historical data, problems as well as positive changes can be identified. Comparing the SEO Visibility of thematically similar websites or competitors will provide the most value as developments of the market environment will be factored in and market trends easily identified.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country as specified in ISO 3166-1 Format: US, GB, DE etc. url String URL for which the SEO Visibility is determined. The Visibility can be queried for a domain, a subdomain or a directory. For a domain, subdomain or directory all belonging sub-pages are included in the calculation. Format: domain.tld, subdomain.domain.tld or domain.tld/directory/
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 264

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetValueSeoVisibility

researchOrganicGetValueSeoVisibilityWorld(query, callback)

Searchmetrics SEO Worldwide Visibility for a given URL.

This call returns the Searchmetrics Visibility across all countries for a domain in the organic search, based on the latest data in our database. The SEO Visibility is composed of search volume and the position of ranking keywords. Each position is individually measured by a calculated factor by Searchmetrics. Also, the SEO Visibility factors in whether the ranking keywords are navigational or informational. What does the SEO Visibility show us? The SEO Visibility presents the current trend and historical development of a domain's visibility in search engines. The index reflects how often a website shows up in the search results. While the SEO Visibility can relate to a website's real traffic, it is important to remember that traffic can come from many different places online. Therefore the SEO Visibility is only an indicator of visibility that comes from a website's organic search channel. SEO Visibility makes it possible to compare the performance of different domains in search engines. With the historical data, problems as well as positive changes can be identified. Comparing the SEO Visibility of thematically similar websites or competitors will provide the most value as developments of the market environment will be factored in and market trends easily identified.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String URL for which the SEO Visibility is determined. The URL can be either an domain, a subdomain or a directory. For a domain, subdomain or directory all belonging sub-pages are included in the calculation. Format: domain.tld, subdomain.domain.tld, domain.tld/directory/
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 276

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetValueSeoVisibilityWorld

researchOrganicGetValueTrafficValue(query, callback)

Estimated paid value of organic search traffic.

Returns the estimated cost of organic traffic if it was gained through Google AdWords advertising (for the last 2 complete months available in our database). The value is calculated from the number of visitors earned through organic search results and the CPC amount that would have been needed to attract them through paid search results. It thus provides a measure for the value of previous SEO efforts. The currency can be specified, default is EUR.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String Country code as specified in ISO 3166-1 Format: US, GB, DE etc url String The domain or subdomain for which the traffic value is estimated. Format: domain.tld, subdomain.domain.tld currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: USD, EUR etc.
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 290

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchOrganicGetValueTrafficValue

researchPaidGetCountDomainKeyword(query, callback)

Number of paid keywords for a domain in a given country.

Returns the number of keywords in Google's paid search for a given domain in a given country for the last month available in our database.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Domain for which the number of paid keywords is determined. Format: domain.tld, subdomain.domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 474

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetCountDomainKeyword

researchPaidGetCountDomainKeywordFilter(query, callback)

Number of paid keywords for a domain in a given country with filter options.

Returns the number of keywords in Google's paid search for a given domain in a given country in a given month. The result can be filtered with a minimum and maximum ranking position e.g. if you want to count only keywords with a ranking position between 1 and 3. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries url String Domain for which the number of paid keywords is determined. Format: domain.tld, subdomain.domain.tld year_month String month for which the number of paid keywords should be queried Format: YYYYMM position_from String <optional> Filter: Lowest ranking of keywords that should be considered in the counting. E.g. if you want to count all keywords starting from the position 4 (meaning 4,5,6 etc.) this parameter has to be set to "4". Format: 1,2,3 etc. position_to String <optional> Filter: Highest ranking of keywords that should be considered in the counting. E.g. if you want to count all keywords up to position 3 ( resulting in all keywords with a SERP of 1, 2 or 3) this parameter has to be set to "3". Format: 2,3,4 etc
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 490

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetCountDomainKeywordFilter

researchPaidGetCountDomainKeywordHistoric(query, callback)

Number of paid keywords for a domain in a given country also for previous months,

Returns the number of keywords in Google's paid search for a given domain in a given country in a given month. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries url String Domain for which the number of paid keywords is determined. Format: domain.tld, subdomain.domain.tld year_month String Date Format: YYYYMM
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 504

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetCountDomainKeywordHistoric

researchPaidGetListAdVariations(query, callback)

Get a list of different ad variations

This call returns a list of different ad variantions for the queried domain.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 519

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetListAdVariations

researchPaidGetListCommonKeywords(query, callback)

Overview comparison of the most relevant shared keywords (comeptititve keywords) for two URLs in paid search results.

Get a list of the most relevant shared keywords in the paid search results for two URLs.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url_1 String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld url_2 String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc. limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 536

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetListCommonKeywords

researchPaidGetListCompetitors(query, callback)

Competitor domains in the paid search

This call returns the competitors in the paid search. A competitor is defined as a domain that shows up in the paid search results for a keyword for which the original domain has a ranking as well.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc. limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 552

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetListCompetitors

researchPaidGetListKeywords(query, callback)

Paid keywords with advertisements for a given domain

This call returns paid keywords associated with advertisements placed for the selected domain. Paid keyword results are pulled from the first 5 pages of the search engine over the last week. What do the Paid Keywords show us? The total amount of paid keywords ranking for a domain in the Searchmetrics database provides us an overview of the domain's advertising coverage. Comparing thematically similar websites or competitors allows users to assess the penetration of the potential in the market. When analyzed in combination with with organic results, the number of paid keywords provides an interesting insight in to the competitor's SEO strategy and the keywords that the competitor chooses to optimize vs. advertise.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: Integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 567

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetListKeywords

researchPaidGetListKeywordsLongtail(query, callback)

Paid keywords with advertisements for a given domain

This call returns paid keywords associated with advertisements placed for the selected domain. Paid keyword results are pulled from the first 5 pages of the search engine over the last month. What do the Paid Keywords show us? The total amount of paid keywords ranking for a domain in the Searchmetrics database provides us an overview of the domain's advertising coverage. Comparing thematically similar websites or competitors allows users to assess the penetration of the potential in the market. When analyzed in combination with with organic results, the number of paid keywords provides an interesting insight in to the competitor's SEO strategy and the keywords that the competitor chooses to optimize vs. advertise.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter ""limit"" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 582

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetListKeywordsLongtail

researchPaidGetListPaidVisibilityHistoric(query, callback)

Searchmetrics Paid Visibility for a given URL and a given country in a given timeframe.

This call returns the Searchmetrics Visibility Rank in the paid Google search for a domain for a specified country in a given timeframe- The Paid Visibility displays the visibility of the selected domain in paid search. It is based on the search volume and ad position of the ranked keywords. Each position is weighted individually according to a factor calculated by Searchmetrics. The Paid Visibility factors in the positioning of an ad whether it is a HPA (High Performance Ad= Ad above the organic results) or a PA (Perfomance Ad= Ad next to the organic results). What does the Paid Visibility show us? Similar to SEO Visibility, Paid Visibility shows the advertising activity of a domain on Google. Changes in the Paid Visibility could result from budget increases or decreases as well as market changes. Users can also compare the Paid Visibility of competitive domains to assess how much of the potential market a domain is capitalizing on with their pay-per-click campaigns. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries date_from String Start date from which the Paid Visibility should be queried Format: YYYYMMDD date_to String End date up to which the Paid Visibility should be queried Format: YYYYMMDD url String Domain for which the Paid Visibility is queried. Format: domain.tld, subdomain.domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 597

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetListPaidVisibilityHistoric

researchPaidGetValuePaidKpis(query, callback)

Collection of Paid Search KPIs: paid traffic, ad budget, clicks per day, average CPC, Paid Rank

This call returns a collection of Paid Search key performance indicators (KPIs) for a given country for the last complete month available in our database. In detail these are: paid traffic, ad budget, clicks per day, average CPC, Paid Rank The currency can be specified, default is EUR.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Domain for which the Google AdWords Budget is estimated. Format: domain.tld currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc.
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 611

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetValuePaidKpis

researchPaidGetValuePaidRank(query, callback)

Searchmetrics Paid Visibility rank of the domain (PaidRank)

This call returns the Paid Visibility rank (PaidRank) for a domain in a given country. The rank represents the position of the domain in the top 100,000 Paid Visibility list for the country. The paid visibility aggregates the collected results of the analyzed site in AdWords advertisements.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String domain Format: domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 624

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetValuePaidRank

researchPaidGetValuePaidVisibility(query, callback)

Searchmetrics Paid Visibility for a given URL and a given country.

This call returns the Searchmetrics Visibility Rank in the paid Google search for a domain for a specified country, based on the latest data in our database. As well a trend in comparision to the previous week is delivered. The Paid Visibility displays the visibility of the selected domain in paid search. It is based on the search volume and ad position of the ranked keywords. Each position is weighted individually according to a factor calculated by Searchmetrics. The Paid Visibility factors in the positioning of an ad whether it is a HPA (High Performance Ad= Ad above the organic results) or a PA (Perfomance Ad= Ad next to the organic results). What does the Paid Visibility show us? Similar to SEO Visibility, Paid Visibility shows the advertising activity of a domain on Google. Changes in the Paid Visibility could result from budget increases or decreases as well as market changes. Users can also compare the Paid Visibility of competitive domains to assess how much of the potential market a domain is capitalizing on with their pay-per-click campaigns.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Domain for which the Paid Visibility is queried. Format: domain.tld, subdomain.domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 637

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchPaidGetValuePaidVisibility

researchSocialGetListFacebook(query, callback)

Facebook interaction per URL for a given domain (likes, shares etc.)

This call returns the Facebook Social Visibility for URLs of a given domain, split in shares, likes etc. and sorted in descending order by the number of likes.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description url String Either a domain, a subdomain or a directory Format: domain.tld, subdomain.domain.tld, domain.tld/directory/ limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 871

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchSocialGetListFacebook

researchSocialGetListTopUrls(query, callback)

Social Visibility (Facebook, Twitter etc.) per URL for a given domain

This call returns the Social Visibility for URLs of a given domain, sorted in descending order by Social Visibility. The Social Visibility is an indicator for the performance on leading social networks (Facebook, Twitter, LinkedIn, Google+1, Pinterest). Social Visibility includes user actions, such as liking or sharing the domain in the social media space (e.g. via Facebook’s like button). The different user actions are weighted differently depending on the influence of the network. A higher Social Visibility score indicates more popularity and interactions in the social media space.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description url String Either a domain, a subdomain or a directory Format: domain.tld, subdomain.domain.tld, domain.tld/directory/ limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10. Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0. Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 885

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchSocialGetListTopUrls

researchSocialGetValueSocialRank(query, callback)

Social Visibility Rank for a given domain in a given country

This call returns the ranking of a domain in comparison with the Social Visibility Values of all other listed domains of a specific country, indicating the domain’s position in the country’s social sphere. For example, if a domain has a social rank of 2, this means that the domain has the second highest social visibility in the country in question. The Social Visibility is created using a unique algorithm, which includes both ratings (e.g. likes and comments) and URL sharing (e.g. over Twitter) for the domain. The various actions are weighted differently depending on their impact on visibility. In addition, the call returns the Social Rank all-time-high for for the selected domain plus a median of the Social Rank of its competitors.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain or subdomain Format: domain.tld, subdomain.domain.tld
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 898

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchSocialGetValueSocialRank

researchSocialGetValueSocialSpread(query, callback)

Social Spread for a given domain

This call returns the Social Spread for a given domain or subdomain. The Social Spread is the social link distribution across all monitored networks like Facebook, Twitter and Google +1. For the distribution not only the absolute quantity of social actions is relevant but also the type. Actions with a more complex activity level such as a comment count more than a simple activity like the click on a "like"-button.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String Either a domain, a subdomain or a directory Format: domain.tld, subdomain.domain.tld, domain.tld/directory/
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 910

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchSocialGetValueSocialSpread

researchSocialGetValueSocialSpreadFilter(query, callback)

Social Spread for a given domain, subdomain,directory or URL with historic data

This call returns the Social Spread for a given domain, subdomain or directory or specific URL for a given week Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description date_from String Start UNIX timestamp. Please see www.unixtimestamp.com for details. Format: integer date_to String End UNIX timestamp. Please see www.unixtimestamp.com for details. Format: integer url String Either a domain, subdomain or directory. If this value is entered the call returns the cumulated social spread for all URLs that contain the string entered here. Format: domain.tld, subdomain.domain.tld, domain.tld/directory/
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 924

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchSocialGetValueSocialSpreadFilter

researchSocialGetValueSocialSpreadHistoric(query, callback)

Social Spread for a given domain with historic data

This call returns the Social Spread for a given domain or subdomain for a given week Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description date_from String Start UNIX timestamp. Please see www.unixtimestamp.com for details. Format: integer date_to String End UNIX timestamp. Please see www.unixtimestamp.com for details. Format: integer url String Either a domain, a subdomain or a directory Format: domain.tld, subdomain.domain.tld, domain.tld/directory/
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 938

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchSocialGetValueSocialSpreadHistoric

researchSocialGetValueVisibility(query, callback)

Social Visibility for a given domain

This call returns the Social Visibility for a given domain or subdomain on leading social networks (Facebook, Twitter, LinkedIn, Google+1, Pinterest). Social Visibility includes user actions, such as liking or sharing the domain in the social media space (e.g. via Facebook’s like button). The different user actions are weighted differently depending on the influence of the network. What does Social Visibility show us? A higher Social Visibility score of a domain indicates more popularity and interactions in the social media space. Comparing a domain with thematically similar websites or competitors helps to assess the strength of the domain in the market as well as identify potential growth opportunities.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description url String Either a domain, subdomain or directory. If this value is entered the call returns the cumulated visibility for all URLs that contain the string entered here. Format: domain.tld, subdomain.domain.tld, domain.tld/directory/
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 950

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchSocialGetValueVisibility

researchSocialGetValueVisibilityFilter(query, callback)

Historic Social Visibility for a given URL or directory for a given week

This call returns the Social Visibility for a given URL on leading social networks (Facebook, Twitter, LinkedIn, Google+1, Pinterest) for a given week for a given url or directory. Social Visibility includes user actions, such as liking or sharing the domain in the social media space (e.g. via Facebook’s like button). The different user actions are weighted differently depending on the influence of the network. What does Social Visibility show us? A higher Social Visibility score of a domain indicates more popularity and interactions in the social media space. Comparing a domain with thematically similar websites or competitors helps to assess the strength of the domain in the market as well as identify potential growth opportunities. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description date_from String Start UNIX timestamp. Please see www.unixtimestamp.com for details. Format: integer date_to String End UNIX timestamp. Please see www.unixtimestamp.com for details. Format: integer url String Either a domain, subdomain or directory. If this value is entered the call returns the cumulated visibility for all URLs that contain the string entered here. Format: domain.tld, subdomain.domain.tld, domain.tld/directory/
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 964

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchSocialGetValueVisibilityFilter

researchSocialGetValueVisibilityHistoric(query, callback)

Historic Social Visibility for a given domain for a given week

This call returns the Social Visibility for a given domain or subdomain on leading social networks (Facebook, Twitter, LinkedIn, Google+1, Pinterest) for a given week. Social Visibility includes user actions, such as liking or sharing the domain in the social media space (e.g. via Facebook’s like button). The different user actions are weighted differently depending on the influence of the network. What does Social Visibility show us? A higher Social Visibility score of a domain indicates more popularity and interactions in the social media space. Comparing a domain with thematically similar websites or competitors helps to assess the strength of the domain in the market as well as identify potential growth opportunities. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description date_from String Start UNIX timestamp. Please see www.unixtimestamp.com for details. Format: integer date_to String End UNIX timestamp. Please see www.unixtimestamp.com for details. Format: integer url String Either a domain, subdomain or directory. If this value is entered the call returns the cumulated visibility for all URLs that contain the string entered here. Format: domain.tld, subdomain.domain.tld, domain.tld/directory/
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 978

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchSocialGetValueVisibilityHistoric

researchUniversalGetListRankingsDomain(query, callback)

Keyword rankings for a given domain in universal search results.

This call returns a list keywords of a domain that had rankings in the universal search results in Google in a given country, based on the latest results in our database. The result includes a lot of additional information (please check result description) and are ordered by estimated traffic in descending order.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain, a subdomain or a directory Format: domain.tld, subdomain.domain.tld, domain.tld/directory/ limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 804

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchUniversalGetListRankingsDomain

researchUniversalGetListRankingsDomainFilter(query, callback)

Historic keyword rankings for a given domain in universal search results with filter options.

This call returns a list keywords of a domain that had rankings in the universal search results in Google in a given country for a given date with several filter options. The result includes a lot of additional information (please check result description) and are ordered by estimated traffic in descending order. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries date String Date for which the universal rankings are queried Format: YYYYMMDD type String Universal search type. Possible values are universal, news, maps, video, images and shopping. Format: string (e.g type4, type5 etc.) url String Either a domain, a subdomain or a directory Format: domain.tld, subdomain.domain.tld, domain.tld/directory/ currency String <optional> Currency code as specified in ISO 4217. Default is "EUR". Format: EUR, USD etc. limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer position_from String <optional> Filter: Lowest ranking of keywords that should be returned. E.g. if you want all keywords starting from the position 4 (meaning 4,5,6 etc.) this parameter has to be set to "4". Format: integer position_to String <optional> Filter: Highest ranking of keywords that should be returned. E.g. if you want all keywords up to position 3 ( resulting in all keywords with a SERP of 1, 2 or 3) this parameter has to be set to "3". Format: integer search_volume_monthly_from String <optional> Filter: Lowest monthly search volume in Google for returned keywords. E.g. if you want all keywords with a minimum estimated search volume of 300 this parameter has to be set to "300". Format: integer search_volume_monthly_to String <optional> Filter: Highest estimated monthly search volume for returned keywords. E.g. if you want all keywords with a maximum estimated monthly search volume of 1000 this parameter has to be set to "1000". Format: integer traffic_monthly_from String <optional> Filter: Lowest estimated traffic for returned keywords. E.g. if you want all keywords with a minimum estimated traffic of 300 visitors this parameter has to be set to "300". Format: integer traffic_monthly_to String <optional> Filter: Highest estimated traffic for returned keywords. E.g. if you want all keywords with a maximum estimated traffic of 1000 visitors this parameter has to be set to "1000". Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 828

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchUniversalGetListRankingsDomainFilter

researchUniversalGetListRankingsDomainHistoric(query, callback)

Historic keyword rankings for a given domain in universal search results

This call returns a list keywords of a domain that had rankings in the universal search results in Google in a given country for a given date. The result includes a lot of additional information (please check result description) and are ordered by estimated traffic in descending order. Please note that a certain subscription level may be needed to use this call.

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Argument Description countrycode String A two letter country code as specified in ISO 3166-1 Format: http://api.searchmetrics.com/api-calls/countries date String Date for which the universal rankings are queried Format: YYYYMMDD url String Either a domain, a subdomain or a directory Format: domain.tld, subdomain.domain.tld, domain.tld/directory/ limit String <optional> Limit for the number of result rows Permitted values are 10, 25, 50, 100, 250 Default is 10 Format: integer offset String <optional> Offset for result set Must be a multiple of allowed values for the parameter "limit" Default is 0 Format: integer
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 844

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchUniversalGetListRankingsDomainHistoric

researchUniversalGetListVisibility(query, callback)

Searchmetrics Visibility for Universal Search for a given URL in a given country.

This call returns the Searchmetrics Visibility in the Universal Search for a domain for a specified country based on the latest data in our database. The Visibility is composed of search volume and the position of universal keyword rankings and reflects how present a website is in the universal search results. The Visibility is split into the different universal search types (images, video, news etc.)

Parameters:

Name	Type	Description
query	Object	The query parameters which will be sent to the api Properties Name Type Description countrycode String A two letter country code as specified in ISO 3166-1 Format: US, GB, DE etc. url String Either a domain, a subdomain or a directory Format: domain.tld, subdomain.domain.tld, domain.tld/directory/
callback	searchmetrics~ApiCallback

Source:

• endpoints.js, line 857

See:

• http://api.searchmetrics.com/api-calls/service/v1/ResearchUniversalGetListVisibility

Type Definitions

apiCallback(data)

This callback is invoked when the api call was successfull and returns all the data

Parameters:

Name	Type	Description
data	object	the response data from the api servers

Source:

• searchmetrics.js, line 54