Getting started
Authorization
To use the Rush Analytics API, you must get an API key, which can be found in your Rush Analytics user account. Use it for all API requests.
If an API method is activated without an API key or an invalid API key is passed in the request, the server returns an “Invalid API key” error.
Getting an API Key
To start using the API:
- Login to your account;
- Go to menu -> API;
- Click the “Get API-key” button.
Please note that API is supported only on Pro and higher Subscription Plans. There is no access to API оn Start Subscription plan.
Return format
Task results are available in Json format and Excel files.
Limits and restrictions
To ensure uninterrupted work of API for all clients, we limit the speed of sending requests. Any API method can be accessed no more than once per second.
If the client application makes more than 1 request per second, then our server will return an error, if the speed is not reduced – your IP will be temporarily blocked. Different subscription plans have different numbers of concurrent API threads.
- Pro plan – 1 thread.
- Pro+ – 10 threads.
- Team – 20 threads.
- Business – 30 threads.
- Business+ – 50 threads.
- Corp – 100 threads.
API thread allows you to run 1 task, check the project status or get results. Until the request is completed, you won’t be able to make a second request to the API. For example: if you have started 1 task – you will be able to start another task or check its status only after the started task is ready. As long as it is in the process of data collection, you cannot create a new task, check the status or get results on another task.
Request Parameters
To test the API: https://app.rush-analytics.com/apiv2/doc/
List of languages – https://app.rush-analytics.com/apiLanguages.php
List of region IDs in Google – https://app.rush-analytics.com/apiRegionsGoogle.php
List of region IDs in Yandex – https://app.rush-analytics.com/apiRegionsYandex.php
Basic information
Documentation for the API can be found at https://app.rush-analytics.com/apiv2/doc/
From a practical point of view – the API passes your data to Rush Analytics to create a task in the system, which gets in line for parsing. You check the status of the task with your application, and as soon as it is ready – you get the result.
API usage prices:
All prices are identical to regular task creation in Rush Analytics – prices are available on page: https://rush-analytics.com/pricing-plans
Rank tracker
This method allows you to get a list of positions and relevant URLs by keywords for several search engines, as well as URLs of topic leaders and their positions.
Request Parameter
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
name | string | Name of task | Checking positions for website “X” |
url | string | url or domain of the site for which the position is checked | https://rush-analytics.com/ |
competitors | string | the domain of a competitor’s website. Up to 10 domains can be entered | https://site24.com |
dataCollectionFrequency | int | Frequency of collection: 0 – daily, 1 – weekly, 2 – in manual mode, 3 – by day of the week. | 0, 1, 2 etc. |
days | string | Used when selecting to collect data on specific days. Day designation: 0,1,2,3,4,5,6. 0 – Monday, 1 – Tuesday, etc. If more than one day is to be specified, separate them with a comma. | 0, 1, 2 etc. |
hour | int | Start time for data collection. Format: 0 – 23, where 0 – 0:00; 1 AM – 01:00. | 10 |
yandexRegions | Yandex search engine region | ||
googleRegions | Google search engine region | ||
type | string | Domain area | .com |
Id | int | Id region of the search engine. List of Yandex regions –https://app.rush-analytics.com/apiRegionsYandex.php List of Google regions – https://app.rush-analytics.com/apiRegionsGoogle.php | 213 |
lang | string | The language in which the data will be collected is – https://app.rush-analytics.com/apiLanguages.php | en |
device | int | The device on which the data will be collected: 0 – Desktop 1 – Mobile | 0 |
keywords | string | Keywords | semantic core |
target url | string | Target URL | https://rush-analytics.com/ |
group | string | Name of the keyword group | semantic |
Example request
{
"apikey": "1ae...af4b",
"name":"google reg",
"url":"https://apple.com/",
"competitors":[
"https://samsung.com"
],
"dataCollectionFrequency":{
"frequency":0
},
"yandexRegions":[
{
"type":".ru",
"id":213,
"lang":"ru",
"device":0
}
],
"googleRegions":[
{
"type":".de",
"id":1003854,
"lang":"de",
"device":0
},
{
"type":".ae",
"id":1000010,
"lang":"en",
"device":1
},
{
"type":".ae",
"id":1000011,
"lang":"en",
"device":1
},
{
"type":".ae",
"id":1000012,
"lang":"en",
"device":1
},
{
"type":".ae",
"id":1000013,
"lang":"en",
"device":1
}
],
"keywords":[
{
"keyword":"phone",
"targeturl":"https://apple.com/",
"group":"mobile"
}
]
}
Checking status
GET /status/
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Type id | int | Id check position | 3 |
Project id | int | Task Id | 330098 |
Getting the result
GET /results/
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Project id | int | Task Id | 330098 |
page | int | The number of the results page: 1 – first 1000 results. 2 – results from 1001-2000 etc. | 1 |
periodStart | String($date) | Get results from the date | 2021-09-13 |
periodEnd | String($date) | Get the results, ending with the date | 2021-12-14 |
competitors | string | Competitor’s domain. Used only to obtain results for competitor positions | site.com |
Example of a request to get results from the position dynamics tab
https://app.rush-analytics.com/apiv2/result/ranktracker/dynamic/24ХХ3/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998e8...ХХХ
Example of a response
[{
"keywords": [
{
"keyword": "phone",
"wordstat": 521,
"wordstat ''": 113,
"wordstat '!'": 53,
"group": "mobile",
"targeturl": "https://www.apple.com",
"relevanturl": "https://www.apple.com/",
"positions": [
{
"date": "08.12.2021",
"position": "16"
},
{
"date": "14.12.2021",
"position": "24",
"diff": -8
}
]
Example request to get results from the visibility tab
https://app.rush-analytics.com/apiv2/result/ranktracker/visibility/2ХХХ3/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998...ХХХ
Example of a response
{
"visibility": [
{
"traffic": 1358,
"group": "Mobile",
"visibilities": [
{
"date": "14.09.2021",
"visibility": 57.1
},
{
"date": "27.11.2021",
"visibility": 48.27,
"diff": -8.83
}
]
},
{
"traffic": 357,
"group": "group1",
"visibilities": [
{
"date": "14.09.2021",
"visibility": 60.33
},
{
"date": "27.11.2021",
"visibility": 51.66,
"diff": -8.67
}
]
},
{
"traffic": 0,
"group": "group2",
"visibilities": [
{
"date": "14.09.2021",
"visibility": 85
},
{
"date": "27.11.2021",
"visibility": 10,
"diff": -75
}
]
}
]
}
Example request for a list of competitors (needed to get positions by competitors)
https://app.rush-analytics.com/apiv2/result/ranktracker/competitors/22ХХХ/1?apikey=acc998e8...ХХХ
Example of a response
["assistentus.com",
"planfact.io",
"ru.wikipedia.org",
"netology.com",
"kom-dir.com",
"vc.com",
"gc.com",
"hh.com",
"hr-director.com",
"timeweb.com"
]
Example request for a list of project regions
https://app.rush-analytics.com/apiv2/result/ranktracker/regions/23ХХХ/1?apikey=acc998...ХХХ
Example of a response
[
{
"searchEngine": [
{
"id": 33091,
"name": "Google.com - Switzerland (20133)",
"device": "desktop"
},
{
"id": 33094,
"name": "Google.ae - Greece (20361)",
"device": "mobile"
}
]
}
]
Example of a request to get a position history
https://app.rush-analytics.com/apiv2/result/ranktracker/positions_history/24ХХХ/1?periodStart=2021-11-13&periodEnd=2021-11-28&apikey=acc998e...ХХХ
Example of a response
[
{
"keyword": "phone",
"positions_history": [
{
"date": "14.12.2021",
"position": "24 (-8)"
},
{
"date": "08.12.2021",
"position": "16"
}
]
Example of a request to retrieve a URL history
https://app.rush-analytics.com/apiv2/result/ranktracker/urls_history/24XXX/1?periodStart=2021-11-13&periodEnd=2021-11-28&apikey=acc998e...XXX
Example of a response
[
{
"keyword": "phone",
"target_url": "/iphone-13-pro/key-features/",
"urls_history": [
{
"date": "14.12.2021",
"url": "https://www.apple.com/iphone-13-pro/key-features/"
},
{
"date": "08.12.2021",
"url": "https://www.apple.com/iphone-13-pro/key-features/com"
}
]
Example of a request to retrieve a snippet history
https://app.rush-analytics.com/apiv2/result/ranktracker/snippets_history/24XXX/1?periodStart=2021-11-13&periodEnd=2021-11-28&apikey=acc998e...XXX
Example response
[
{
"keyword": "phone",
"position": "24",
"snippets_history": [
{
"date": "14.12.2021",
"snippet": "iPhone 13 Pro takes a huge leap forward, bringing incredible speed to everything you do and dramatic new photo and video capabilities — all in two great sizes."
},
{
"date": "08.12.2021",
"snippet": "See the Apple Card Customer Agreement for more information. ACMI is not available for purchases made online at the following special stores: Apple Employee Purchase Plan"
}
]
Example of a request to get visibility on competitors
https://app.rush-analytics.com/apiv2/result/ranktracker/competitors_visibility/244XXX/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998...XXX
Example response
[
{
"competitor": "Samsung.com",
"visibilities": [
{
"date": "08.12.2021",
"visibility": "9.27%"
},
{
"date": "14.12.2021",
"visibility": "7.85% (-1.42%)"
}
]
},
{
"competitor": "planfact.io",
"visibilities": [
{
"date": "08.12.2021",
"visibility": "31.04%"
},
{
"date": "14.12.2021",
"visibility": "29.29% (-1.75%)"
}
]
Example of a request for topic leaders
https://app.rush-analytics.com/apiv2/result/ranktracker/competitors_leaders/24ХХХ/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998...ХХХ
Example response
[
{
"competitor": "samsung.com",
"top10_info": [
{
"date": "14.12.2021",
"top10_keywords": 14
}
]
},
{
"competitor": "planfact.io",
"top10_info": [
{
"date": "14.12.2021",
"top10_keywords": 52
}
]
},
]
Example of a request to get competitors’ positions
https://app.rush-analytics.com/apiv2/result/ranktracker/competitors_positions/24ХХХ/1?periodStart=2021-09-13&periodEnd=2021-11-28&competitor=mossite24.ru&apikey=acc998e...ХХХ
Example response
[
{
"keyword": "phone",
"wordstat": 521,
"group": "mobile",
"positions": [
{
"date": "08.12.2021",
"position": "> 100"
},
{
"date": "14.12.2021",
"position": "> 100"
}
]
},
{
"keyword": "iPhone",
"wordstat": 521,
"group": "mobile",
"positions": [
{
"date": "08.12.2021",
"position": "> 100"
},
{
"date": "14.12.2021",
"position": "> 100"
}
]
Example of a request to get a comparison of positions by region
https://app.rush-analytics.com/apiv2/result/ranktracker/compare_regions/24XXX/1?periodStart=2021-09-13&periodEnd=2021-11-28&apikey=acc998...XXX
Example response
[
"keyword": "iPhone",
"regions_positions": [
{
"region": "Google.com - Switzerland (20133)",
"device": "desktop",
"lang": "de",
"id": 328368,
"date": "14.12.2021",
"position": "1"
}
]
Rank tracker Light
This method allows you to get a list of positions, relevant URLs by keywords, as well as URLs of topic leaders.
Request parameter
itle | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
name | string | Name of task | Checking positions for website “X” |
url | string | url or domain of the site for which the position is checked | https://rush-analytics.com/ |
yandexRegions | Yandex search engine region | ||
googleRegions | Google search engine region | ||
type | string | Domain area | .com |
Id | int | Id region of the search engine. List of Yandex regions –https://app.rush-analytics.com/apiRegionsYandex.php List of Google regions – https://app.rush-analytics.com/apiRegionsGoogle.php | 213 |
lang | string | The language in which the data will be collected is – https://app.rush-analytics.com/apiLanguages.php | en |
device | int | The issuing device on which the data will be collected: 0 – Desktop 1 – Mobile | 0 |
keywords | string | Keywords | semantic core |
Getting the result
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Project id | int | Task id | 324234 |
Checking status
Title | Format | Description | Example |
---|---|---|---|
Type id | int | Id Rank tracker Light | 1 |
Project id | int | Task id | 324234 |
apikey | string | Your API key | n/a |
Example request
{
"apikey": "acc99ХХХ…dcef",
"name": "Name",
"url": "rush-analytics.com",
"yandexRegions": [
{
"type": ".ru",
"id": 213,
"lang": "ru",
"device": 0
}
],
"googleRegions": [
{
"type": ".de",
"id": 2311976,
"lang": "de",
"device": 0
}
],
"keywords": [
"phone"
]
}
Example response
[
{
"regionid": "20256",
"searchEngine": "Google",
"device": "0",
"keywords": [
{
"keyword": "phone",
"position": "19",
"url": "https://www.apple.com/ipad/compare/"
}
],
"leadersOfTheme": [
{
"domain": "ru.wikipedia.org",
"visibility": 1
},
{
"domain": "TexTerra.ru",
"visibility": 1
},
}
]
},
{
"regionid": "1011969",
"searchEngine": "Google",
"device": "0",
"keywords": [
{
"keyword": "iPhone",
"position": "10",
"url": "https://www.apple.com/"
}
],
"leadersOfTheme": [
{
"domain": "ru.wikipedia.org",
"visibility": 1
},
{
"domain": "texterra.ru",
"visibility": 1
}
]
Collecting the TOP 10 URLs
This method allows you to get the top 10-100 URLs by keywords, as well as URL topic leaders.
Example request
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
name | string | Name of task | Checking positions for website “X” |
depth | int | Parsing depth (10,20, 30, 40, 50, 60, 70, 80, 100) | 10 |
searchEngine | string | Search engine (Yandex or Google) | |
type | string | Domain area | .com |
Id | int | Id region of the search engine. List of Yandex regions –https://app.rush-analytics.com/apiRegionsYandex.php List of Google regions – https://app.rush-analytics.com/apiRegionsGoogle.php | 1003854 |
lang | string | The language in which the data will be collected is – https://app.rush-analytics.com/apiLanguages.php | de |
keywords | string | Keywords | phone |
Checking status
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Project id | int | Task id | 324234 |
Getting the results
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Project id | int | Task id | 324234 |
Example request
{
"apikey": "b9eeХХХ….251",
"name": "Name",
"depth": 10,
"searchEngine": "Google",
"region": {
"type": ".de",
"id": 1003854,
"lang": "de"
},
"keywords": [
"phone"
]
}
Example response
{
"regionid": 1003854,
"keywords": [
{
"keyword": "phone",
"urls": [
"https://www.apple.com/ipad/compare/",
"https://https://www.apple.com/ipad-pro/",
],
"titles": []
}
],
"leadingDomains": {
"ru.wikipedia.org": 1,
"docs.microsoft.com": 1,
"developer.mozilla.org": 1,
"ravesli.com": 1
}
}
Checking the site indexing
This method allows you to check the indexing of pages in web search engines Yandex and Google.
Example request
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
name | string | Name of task | Checking positions for website “X” |
urls | string | URLs for checking. | https://rush-analytics.com/pricing-plans |
searchEngines | string | Search engine (Yandex, Google) | “”Yandex”, “Google” |
googleCountry | string | Google region domain area | .com |
googleLanguage | string | The language of the Google region | en |
Checking status
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Type id | int | Id for indexing (5) | 1 |
Project id | int | Task id | 324234 |
Example response
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Project id | int | Task id | 324234 |
Example request
{
"apikey": "b9eXXX….251",
"name": "Name",
"urls": [
"https://rush-analytics.com/pricing-plans"
],
"searchEngines": [
"Yandex",
"Google"
],
"googleCountry": ".de",
"googleLanguage": "de"
}
Example response
1 – URL indexed by a search engine
0 – URL not indexed by search engine
[
{
"url": "https://rush-analytics.com/pricing-plans",
"yandexIndexed": "1",
"googleIndexed": "1"
}
]
Keyword suggest tool
This method allows you to collect search suggestions from Yandex, Google and Youtube.
Request parameters
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
name | string | Name of task | Checking positions for website “X” |
yandexRegions | int | List of Yandex regions –https://app.rush-analytics.com/apiRegionsYandex.php | |
googleRegions | int | List of Google regions – https://app.rush-analytics.com/apiRegionsGoogle.php | |
country | string | Google domain area, Youtube domain area | .com |
language | string | Language of Google, Youtube region – https://app.rush-analytics.com/apiLanguages.php | en |
youtubeRegion | Adding a Youtube region | ||
depth | int | Depth of data collection (1, 2, 3). We recommend selecting 1 | 1 |
keywords | string | keywords | phone |
stopwords | string | Negative keywords – remove unnecessary keywords found | free |
Checking status
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Type id | int | Id for Keyword suggest tool(7) | 7 |
Project id | int | Task id | 324234 |
Getting the results
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Project id | int | Task id | 324234 |
Example request
{
"apikey": "b9eХХХ….5251",
"name": "Name",
"yandexRegionId": 177,
"googleRegion": {
"country": ".de",
"language": "de"
},
"youtubeRegion": {
"country": ".de",
"language": "de"
},
"depth": 1,
"keywords": [
"phone"
],
"stopwords": [
"free"
]
}
Example response
{
"phone guru martinsried",
"phone gimbal",
"phone guy",
"phone guy death",
"phone guy death reaction",
"phone green screen footage",
"phone guy calls fnaf 1",
]
}
Yandex Keyword Research
This method allows you to collect keywords and search volume from Yandex Wordstat.
Request parameters
Titlle | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
name | string | Name of task | Checking positions for website “X” |
regionid | int | Id region of the Yandex search engine. The list of IDs is https://app.rush-analytics.com/apiRegionsYandex.php | 213 |
projecttype | string | What to collect: keywords or frequency ( Keywords /SearchVolume) | Keywords |
pages | int | Parse pages in the left-hand column of Wordstat (1-10/40) This parameter is only specified when collecting keywords. | 1 |
normal | string | Total search volume. Specified only for search volume collection tasks. | true |
parenthesis | string | Partial occurrence. Search volume of the word type. Specified only for search volume collection tasks. | true |
exclamation | string | Search volume of type “!exact !occurrence”. Specified only for search volume collection tasks. | true |
wordorder | string | Search volume with word order taken into account. Used together with exclamation, parenthesis, normal. Specified only for keyword ordering search volume collection tasks. | true |
minimumwordstat | int | Filtering that removes queries with a search volume equal to or lower than the specified level from the results. (may not be used) | 0 |
keywords | string | keywords | Phone |
stopwords | string | Negative keywords – remove unnecessary keywords found | Free |
Checking the status
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Type id | int | Id for Yandex Keyword Research (4) | 4 |
Project id | int | Task id | 324234 |
Example response
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Project id | int | Task id | 324234 |
Example request
{
"apikey": "acc99XXX…347dcef",
"name": "Name",
"regionid": 213,
"projecttype": "phone",
"pages": 10,
"keywords": [
"mobile"
],
"stopwords": [
"free"
]
}
Response example
{
"wordstatKeywordResult": [{
"keyword": "phone",
"collectedKeywords": [
{
"keyword": "mobile",
"displays": 3113172
},
{
"keyword": "land",
"displays": 560883
}
]
}
],
"regionid": 21346
}
Search volume checker
This method allows you to collect the search volume of keywords from Google Keyword Planner
Request parameters
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
name | string | Name of task | Checking positions for website “X” |
googleRegion | Google search engine | ||
country | string | Domain area in Google | .com |
region | int | Id region Google. The list of IDs is https://app.rush-analytics.com/apiRegionsGoogle.php | 2756 |
language | string | The language in which the data will be collected is – https://app.rush-analytics.com/apiLanguages.php | en |
keywords | string | keywords | phone |
stopwords | string | Negative keywords – remove unnecessary keywords found | free |
Checking the status
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Type id | int | Id for Search volume checker(15) | 15 |
Project id | int | Task id | 324234 |
Example response
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your API key | n/a |
Project id | int | Task id | 324234 |
Example request
{
"apikey": "acc99ХХХ…47dcef",
"name": "Name",
"googleRegion": {
"country": ".de",
"region": 9068242,
"language": "de"
},
"keywords": [
"auto"
],
"stopwords": [
"free"
]
}
Example response
{
"adWordsKeywordResult": [
{
"keyword": "iPhone 13 Pro max",
"count": 120
}
]
}
Get a list of the id of tasks created in a specific tool
Request parameters
Title | Format | Description | Example |
---|---|---|---|
apikey | string | Your api key | n/a |
name | string | Name of task | Checking positions for website “X” |
Type | int | Types of tasks: 1 – Rank tracker, 2 – Collecting the top 10 URLs, 5 – Checking the site indexing, 7 – Keyword suggest tool, 4 – Yandex Keyword Research, 15 – Search volume checker. |
Example request
https://app.rush-analytics.com/apiv2/projectids?apikey=acc...XXX7dcef&projecttype=2
Example response
{
"1": [
{
"id": "182713",
"name": "Name",
"created": "2018-06-04 16:41:01+00",
"keywordcount": "1"
},
{
"id": "183096",
"name": "name",
"created": "2018-06-07 09:09:45+00",
"keywordcount": "1"
{
"id": "734520",
"name": "QWERTY",
"created": "2021-08-10 06:54:11+00",
"keywordcount": "1"
}
]
}
Credit balance check
This module allows you to check the balance of your plan.
To do this, you need to add your API key to the request:
https://app.rush-analytics.com/apiv2/balance?apikey=b9ХХХ...5251
Errors
All API methods can return the following error codes
Error | Code | Description | Solution |
---|---|---|---|
Error: Forbidden | 403 | No more free API threads | There are no free threads left. Upgrade your subscription with more threads or wait. |
Bad Request | 400 | Unknown project type | Some of the data required to create the task is missing from the request. |
Bad Request | 400 | Invalid API key | Check that the API key has been entered correctly |
Bad Request | 400 | Google/Yandex region xxx is not supported | Check that the region id is correct |
Bad Request | 400 | cannot be converted to valid domain | You have entered an invalid domain. Check it and enter a valid domain. |
Bad Request | 400 | Region «ххх» is not valid for domain “хх» | You made a mistake when entering the “type” parameter – check it and make sure the domain case is in the correct format. |
Bad Request | 400 | “xxx” is not supported Yandex / Google language | You have made a mistake in the “lang” parameter. – Check it and make sure the language is in the correct format. |
Bad Request | 400 | Region device parameter must be either 0 or 1 | You have made a mistake in the “device” parameter Change the data to 0 (desktop) or 1 (mobile) |
Bad Request | 400 | API key not found in request | Add an API key to the request. |
Bad Request | 400 | All your keywords were filtered out by stopwords | All keywords have been removed by stop words. Check your stop words and repeat the request. |
Bad request | 400 | Country missing from google region | Add a country for the region you specify. Example “.com” |
Bad request | 400 | Country missing from youtube region | Add a country for the region you specify. Example “.com” |
Bad request | 400 | Depth missing from parameters | Specify the depth of collection of search suggestions “1-3” |
Bad request | 400 | Empty URL | Set the domain of the site to check the positions. |
Bad request | 400 | Empty name | Specify the name of the task. |
Internal Server Error | 500 | Error has occured, please try again later” . $e->getMessage() | An error has occurred. Check the request and repeat it again. |
Bad request | 400 | Failed to find project $projectid of type $projecttypeName | The task was not found. Repeat the request again or contact our support team. |
Bad request | 400 | GoogleRegion missing from parameters | Specify the Google region for your task. |
Bad request | 400 | Invalid depth, allowed depths are ” . join(‘,’, $allowedDepths) | You have entered the wrong data collection depth parameter in the search suggestions. Replace it with 1-3 |
Bad request | 400 | Keywords missing from parameters | Add keywords to the task. |
Bad request | 400 | Language missing from google region | Add a language for the Google region. |
Bad request | 400 | Language missing from youtube region | Add a language for the Youtube region. |
Bad request | 400 | Maximum keyword length is 2000 characters | In the rank tracker, the maximum allowable keyword length is 2000 characters. Reduce the length of your keywords. |
Bad request | 400 | Missing apikey parameter | Add an API key to the request. |
Bad request | 400 | Name missing from parameters | Specify the name of the task. |
Forbidden | 403 | Not allowed to create project through API | Your subscription plan does not have API access. Upgrade to a plan with API access. |
Bad request | 400 | Not authorized | Not authorized. Contact our support team. |
Bad request | 400 | Not enough credits. | There are not enough credits on your plan to create a task. Buy more credits. |
Bad request | 400 | Please choose at least one type of search volume: normal, parenthesis or exclamation | To create a task, at least 1 of the search volume types must be set as “true” |
Bad request | 400 | Project does not exist | The task does not exist |
Bad request | 400 | Project is not in done status | The task is being processed. Repeat the request later. |
Bad request | 400 | Project with ID $projectid of type $projecttype does not exist | The task does not exist |
Bad request | 400 | Projecttype missing from parameters | Specify the PROJECTTYPE for the task. |
Bad request | 400 | Region missing from google region | Specify the region’s id. |
Bad request | 400 | Region missing from parameters | The region of data collection is not specified. |
Bad request | 400 | Regionid missing from parameters | Specify the region’s id. |
Bad request | 400 | Request body is not a valid JSON | Check the validity of your request. |
Bad request | 400 | URL missing from parameters | Set the domain of the site to check the positions. |
Bad request | 400 | URLs missing from parameters | Set the URL to check indexation. |
Bad request | 400 | Unknown API function | Unknown API function. |
Bad request | 400 | Unknown project type ‘$projectTypeString’ | The PROJECTTYPE is not set correctly. Example of a valid PROJECTTYPE for the yandex keywords research tool “Keywords” or “SearchVolume” |
Bad request | 400 | Unsupported search engine. Supported types: Google, Yandex | Search engines that are supported: “Yandex and Google |
Bad request | 400 | You must choose at least 1 keyword | You need to add keywords to the task. |
Bad request | 400 | You must choose at least 1 region | At least 1 region must be added to the task. |
Bad request | 400 | You must fill at least one URL | A URL must be added to the task to check indexing. |
Bad request | 400 | You must input at least 1 keyword | You need to add keywords to the task. |
Bad request | 400 | You must choose at least 1 keyword | You need to add keywords to the task. |
Bad request | 400 | You must select at least one region type | At least 1 region must be added to the task. |
Bad request | 400 | You must select at least one search engine. Google or Yandex. | At least 1 search engine must be added. |
Bad request | 400 | You need to select at least one region | At least 1 region must be added to the task. |
Bad request | 400 | googleCountry parameter is empty | Need to add a country parameter to check if the site is indexed by Google |
Bad request | 400 | googleLanguage parameter is empty | Need to add a language parameter to check if the site is indexed by Google |