Skip to content

Latest commit

 

History

History
197 lines (158 loc) · 12 KB

readme.md

File metadata and controls

197 lines (158 loc) · 12 KB

Read the Blog post first :

Semrush API Google sheets

Quick start - no installation needed :

Make a copy of the master spreadsheet with the script and you're ready to go!

Functions

DOMAIN_OVERVIEW_SEMRUSH(domain, db, date, excludeHeaders, cache)

Returns Semrush domain history for a specified domain from January 2012 onwards

DOMAIN_ORGANIC_KEYWORDS_SEMRUSH(domain, filterBy, matchType, query, limit, db, date, excludeHeaders, cache)

Returns Semrush Organic keywords for a specified domain

HISTORICAL_RANKING_KEYWORD_SEMRUSH(domain, query, limit, db, date, excludeHeaders, cache)

Returns Historical rankings for domain/keyword combination

URL_ORGANIC_KEYWORDS_SEMRUSH(url, limit, db, excludeHeaders, cache)

Returns Ranking Semrush Organic keywords per URL

KEYWORD_DIFFICULTY_SEMRUSH(query, db, excludeHeaders, cache)

Returns Semrush Keyword Difficulty for a keyword

SERPS_SEMRUSH(query, limit, db, excludeHeaders, cache)

Returns Semrush organic search results for a specific keyword

RELATED_QUERIES_SEMRUSH(query, limit, db, excludeHeaders, cache)

Returns Related search queries for a keyword from Semrush

KEYWORD_VOLUME_SEMRUSH(query, db, excludeHeaders, cache)

Returns Keyword Volume from semrush

PHRASE_QUESTIONS_SEMRUSH(query, limit, db, filterBySearchVolume, searchVolumeFilter, searchVolume, excludeHeaders, cache)

Returns Questions asked for a keyword from Semrush

DOMAIN_OVERVIEW_SEMRUSH(domain, db, date, excludeHeaders, cache) ⇒

Returns Semrush domain history for a specified domain from January 2012 onwards

Kind: global function Returns: Returns organic keywords count, organic traffic, organic cost, adwords data Customfunction:

Param Type Description
domain "example.com" REQUIRED The root domain, example: "nytimes.com", DO NOT include protocol (http/https)
db "us" OPTIONAL The country database you want to search from. Default is US
date 201601 OPTIONAL Leave this blank for current data. YYYYMM format for historical reports, note: always reports on the 15th of the month.
excludeHeaders true OPTIONAL true to EXCLUDE column headers or false to include. Default is false.
cache "TRUE" OPTIONAL use FALSE if you DO NOT want to cache these results or DO NOT want to return cached results, default is TRUE (cache enabled)

DOMAIN_ORGANIC_KEYWORDS_SEMRUSH(domain, filterBy, matchType, query, limit, db, date, excludeHeaders, cache) ⇒

Returns Semrush Organic keywords for a specified domain

Kind: global function Returns: Access organic keywords for a domain from semrush.com database. Customfunction:

Param Type Description
domain "example.com" REQUIRED The root domain, example: "nytimes.com", DO NOT include protocol (http/https)
filterBy true OPTIONAL Use true to include the query in the filter or false to remove the query in the filter. Default is true
matchType true OPTIONAL Use true for partial match, use false for exact match. Default is true, partial match
query "apartments" OPTIONAL The keyword you want to filter by. Relies on previous 2 parameters. Example: "brown shoes".
limit 10 OPTIONAL Number from 1 to 10000
db "us" OPTIONAL The country database you want to search from. Default is US
date 201601 OPTIONAL Leave this blank for current data. YYYYMM format for historical reports, note: always reports on the 15th of the month.
excludeHeaders true OPTIONAL true to EXCLUDE column headers or false to include. Default is false.
cache "TRUE" OPTIONAL use FALSE if you DO NOT want to cache these results or DO NOT want to return cached results, default is TRUE (cache enabled)

HISTORICAL_RANKING_KEYWORD_SEMRUSH(domain, query, limit, db, date, excludeHeaders, cache) ⇒

Returns Historical rankings for domain/keyword combination

Kind: global function Returns: Access organic keywords for a domain from semrush.com database Customfunction:

Param Type Description
domain "example.com" REQUIRED The root domain, example: "nytimes.com", DO NOT include protocol (http/https)
query "apartments" OPTIONAL The keyword you want to filter by. Relies on previous 2 parameters. Example: "brown shoes".
limit 10 OPTIONAL Number from 1 to 10000
db "us" OPTIONAL The country database you want to search from. Default is US
date 201601 OPTIONAL Leave this blank for current data. YYYYMM format for historical reports, note: always reports on the 15th of the month.
excludeHeaders true OPTIONAL true to EXCLUDE column headers or false to include. Default is false.
cache "TRUE" OPTIONAL use FALSE if you DO NOT want to cache these results or DO NOT want to return cached results, default is TRUE (cache enabled)

URL_ORGANIC_KEYWORDS_SEMRUSH(url, limit, db, excludeHeaders, cache) ⇒

Returns Ranking Semrush Organic keywords per URL

Kind: global function Returns: Access organic keywords for a url from semrush.com database Customfunction:

Param Type Description
url "http://example.com" REQUIRED The exact URL you want data for, MUST include protocol (http/https)
limit "10" OPTIONAL Number from 1 to 10,000, for number of results
db "US" OPTIONAL The database, example "US" for American database. Default is US
excludeHeaders true OPTIONAL true to EXCLUDE column headers or false to include. Default is false.
cache "TRUE" OPTIONAL use FALSE if you DO NOT want to cache these results or DO NOT want to return cached results, default is TRUE (cache enabled)

KEYWORD_DIFFICULTY_SEMRUSH(query, db, excludeHeaders, cache) ⇒

Returns Semrush Keyword Difficulty for a keyword

Kind: global function Returns: Access keyword difficulty for keyword from semrush Customfunction:

Param Type Description
query "apartments" REQUIRED The keyword you want information for. Example: "brown shoes".
db "us" OPTIONAL The country database you want to search from. Default is US
excludeHeaders true OPTIONAL true to EXCLUDE column headers or false to include. Default is false.
cache "TRUE" OPTIONAL use FALSE if you DO NOT want to cache these results or DO NOT want to return cached results, default is TRUE (cache enabled)

SERPS_SEMRUSH(query, limit, db, excludeHeaders, cache) ⇒

Returns Semrush organic search results for a specific keyword

Kind: global function Returns: Access organic search results for a keyword from semrush.com database Customfunction:

Param Type Description
query "apartments" REQUIRED The keyword you want information for. Example: "brown shoes".
limit 10 OPTIONAL Number from 10 to 20, for number of results. Default is 10
db "us" OPTIONAL The country database you want to search from. Default is US
excludeHeaders true OPTIONAL true to EXCLUDE column headers or false to include. Default is false.
cache "TRUE" OPTIONAL use FALSE if you DO NOT want to cache these results or DO NOT want to return cached results, default is TRUE (cache enabled)

RELATED_QUERIES_SEMRUSH(query, limit, db, excludeHeaders, cache) ⇒

Returns Related search queries for a keyword from Semrush

Kind: global function Returns: Returns related queries for a specific keyword from semrush.com Customfunction:

Param Type Description
query "apartments" REQUIRED The keyword you want information for. Example: "brown shoes".
limit 10 OPTIONAL The number of results. Default is 1
db "us" OPTIONAL The country database you want to search from. Default is US
excludeHeaders true OPTIONAL true to EXCLUDE column headers or false to include. Default is false.
cache "TRUE" OPTIONAL use FALSE if you DO NOT want to cache these results or DO NOT want to return cached results, default is TRUE (cache enabled)

KEYWORD_VOLUME_SEMRUSH(query, db, excludeHeaders, cache) ⇒

Returns Keyword Volume from semrush

Kind: global function Returns: Returns search volume, cpc, etc.. Customfunction:

Param Type Description
query "apartments" REQUIRED The keyword you want information for. Example: "brown shoes".
db "us" OPTIONAL The country database you want to search from, default is "us"
excludeHeaders true OPTIONAL true to EXCLUDE column headers or false to include. Default is false.
cache "TRUE" OPTIONAL use FALSE if you DO NOT want to cache these results or DO NOT want to return cached results, default is TRUE (cache enabled)

PHRASE_QUESTIONS_SEMRUSH(query, limit, db, filterBySearchVolume, searchVolumeFilter, searchVolume, excludeHeaders, cache) ⇒

Returns Questions asked for a keyword from Semrush

Kind: global function Returns: Returns Questions asked for a specific keyword from semrush.com Customfunction:

Param Type Description
query "apartments" REQUIRED The keyword you want information for. Example: "brown shoes".
limit 10 OPTIONAL The number of results. Default is 1
db "us" OPTIONAL The country database you want to search from. Default is US
filterBySearchVolume true OPTIONAL If you want to filter by search volume, use TRUE, default is FALSE
searchVolumeFilter ">" OPTIONAL Filters the search volume parameter (next). Use ">" for Greater than, or "<" for Less than. Default is ">" greater than
searchVolume 1000 OPTIONAL A search volume number (per month) you want to filter results by. Both previous parameters need to be set for this to work.
excludeHeaders true OPTIONAL true to EXCLUDE column headers or false to include. Default is false.
cache "TRUE" OPTIONAL use FALSE if you DO NOT want to cache these results or DO NOT want to return cached results, default is TRUE (cache enabled)