SearchByKeyword

This command will only use the 'historic' index.

Status

Command status: Active
Supported by OpenApps API: Yes
Supported by Internal/Reseller API: Yes
Possibly queued processing: No

Purpose

This command returns search data for a given keyword.

Note: This query has a maximum query rate of 3 requests per second per API account.

Resources consumed

Resource Description

AnalysisResUnits

1000

RetrievalResUnits

Actual number of rows of data returned

IndexItemInfoResUnits

Actual number of rows of data returned

Parameters

Parameter Description

cmd

Required: must be set to: SearchByKeyword.

query

Required: The keyword to search for.

scope

0 - returns Root Domains
2 (default) - returns URLs

from

(optional) Where to start the results from.
Min = 0 (default)
Max = 1000

count

10 (default) - How many results to retrieve.
Min = 1
Max = 100

Example queries and response

XML response

<?xml version="1.0" encoding="utf-8"?>
<Result Code="OK" ErrorMessage="" FullError="">
		<GlobalVars IndexBuildDate="2018-07-26 19:27:19" IndexType="0" ServerBuild="2018-07-04 14:49:49" ServerName="SHADOJAGUAR" ServerVersion="1.0.6759.24894" UniqueIndexID="20180726192719-HISTORICAL"/>
	<DataTables Count="2">
		<DataTable Name="Results" RowsCount="10" Headers="RankID|Item|Title|SearchScore|ScoreInTitle|ScoreInURL|ScoreInAnchor|ScoreOther|ScoreMultiplier|CitationFlow|TrustFlow|RefDomains|ExtBackLinks|TopicalTrustFlow_Topic_0|TopicalTrustFlow_Value_0|TopicalTrustFlow_Topic_1|TopicalTrustFlow_Value_1|TopicalTrustFlow_Topic_2|TopicalTrustFlow_Value_2" Count="10" From="0" GeoTarget="us" GeoTargetSource="Default country code: US" Matches="259090" MatchesAfterFilter="259090" MaxTargetTopics="30" MaxTargetTopicsRootDomains="30" MaxTargetTopicsSubDomains="20" MaxTargetTopicsURLs="10" Query="majestic" Scope="2" TargetTopicsCount="3">
			<Row>0|https://majestic.com/|Majestic®: Marketing Search Engine and SEO Backlink Checker|12415|148|2377|9434|456|1.000|62|47|28436|11435001|Computers/Internet/Web Design and Development|43|Reference/Education|39|Computers/Computer Science/Distributed Computing|37</Row>
			<Row>1|http://www.majestic.co.uk/|Majestic Wine - Buy Wine & Champagne Online|6484|150|1763|4128|443|1.000|45|52|4408|512226|Recreation/Food|52|Business/Transportation and Logistics|31|Business|30</Row>
			<Row>2|http://www.majesticseo.com/|Majestic®: Marketing Search Engine and SEO Backlink Checker|4945|115|0|4471|359|1.000|49|38|19456|4537099|Computers/Internet/Web Design and Development|34|Computers/Internet/On the Web|32|News/Newspapers|32</Row>
			<Row>3|http://majestic12.co.uk/bot.php|Majestic-12 : DSearch : MJ12bot|3691|290|0|3013|388|1.000|58|40|86787|3985311|Computers/Software/Operating Systems|37|Computers/Internet/Web Design and Development|32|Computers/Internet/On the Web|32</Row>
			<Row>4|https://twitter.com/Majestic/|Majestic (@Majestic) || Twitter|3435|197|296|2310|632|1.000|55|32|253|693095|Computers/Internet/Web Design and Development|31|Computers/Computer Science/Distributed Computing|27|Reference/Education|27</Row>
			<Row>5|http://www.majesticproducts.com/|Majestic Products: Fireplaces & Home Hearth|3303|96|0|2987|220|1.000|40|18|1443|17131|Business|18|Business/Construction and Maintenance|14|Business/Automotive|13</Row>
			<Row>6|http://www.majesticathletic.com/|Majestic Athletic Store: Shop Majestic Jerseys, Apparel, & Clothing|3101|78|0|2711|312|1.000|41|30|2595|135535|Sports/Events|28|Sports/Multi-Sports|26|Sports/Softball|24</Row>
			<Row>7|http://majesticmadison.com/|Majestic Theatre || Madison, WI|3057|141|0|2643|273|1.000|42|30|841|64334|Reference/Education|28|Society/Government|25|Recreation/Travel|25</Row>
			<Row>8|http://majestic.dallasculture.org/|The Majestic Theatre – Official Site|3015|124|413|2142|336|1.000|41|38|854|7759|Arts/Music|38|Business/Transportation and Logistics|30|Society/Government|30</Row>
			<Row>9|http://www.majestic.sk/|Úvod || Majestic Music Club|2986|107|929|1746|204|1.000|38|20|506|135023|Arts/Music|20|Recreation/Travel|15|Computers/Internet/Searching|10</Row>
		</DataTable>
		<DataTable Name="MiscInfo" RowsCount="6" Headers="Name|Value|Type">
			<Row>FirstResultScoreTotal|12415|0</Row>
			<Row>FirstResultScoreInTitle|148|0</Row>
			<Row>FirstResultScoreInURL|2377|0</Row>
			<Row>FirstResultScoreInAnchor|9434|0</Row>
			<Row>FirstResultScoreOther|456|0</Row>
			<Row>FirstResultScoreMultiplier|1.000|1</Row>
		</DataTable>
	</DataTables>
</Result>

JSON response

{
	"Code" : "OK",
	"ErrorMessage" : "",
	"FullError" : "",
	"IndexBuildDate" : "2018-07-26 19:27:19",
	"IndexType" : 0,
	"ServerBuild" : "2018-07-04 14:49:49",
	"ServerName" : "SHADOJAGUAR",
	"ServerVersion" : "1.0.6759.24894",
	"UniqueIndexID" : "20180726192719-HISTORICAL",
	"DataTables" : {
		"Results" : {
			"Headers" : {
				"Count" : 10,
				"From" : 0,
				"GeoTarget" : "us",
				"GeoTargetSource" : "Default country code: US",
				"Matches" : 259090,
				"MatchesAfterFilter" : 259090,
				"MaxTargetTopics" : 30,
				"MaxTargetTopicsRootDomains" : 30,
				"MaxTargetTopicsSubDomains" : 20,
				"MaxTargetTopicsURLs" : 10,
				"Query" : "majestic",
				"Scope" : 2,
				"TargetTopicsCount" : 3
			},
			"Data" : [
				{ "RankID" : 0, "Item" : "https://majestic.com/", "Title" : "Majestic®: Marketing Search Engine and SEO Backlink Checker", "SearchScore" : 12415, "ScoreInTitle" : 148, "ScoreInURL" : 2377, "ScoreInAnchor" : 9434, "ScoreOther" : 456, "ScoreMultiplier" : "1.000", "CitationFlow" : "62", "TrustFlow" : "47", "RefDomains" : 28436, "ExtBackLinks" : 11435001, "TopicalTrustFlow_Topic_0" : "Computers/Internet/Web Design and Development", "TopicalTrustFlow_Value_0" : "43", "TopicalTrustFlow_Topic_1" : "Reference/Education", "TopicalTrustFlow_Value_1" : "39", "TopicalTrustFlow_Topic_2" : "Computers/Computer Science/Distributed Computing", "TopicalTrustFlow_Value_2" : "37" },
				{ "RankID" : 1, "Item" : "http://www.majestic.co.uk/", "Title" : "Majestic Wine - Buy Wine & Champagne Online", "SearchScore" : 6484, "ScoreInTitle" : 150, "ScoreInURL" : 1763, "ScoreInAnchor" : 4128, "ScoreOther" : 443, "ScoreMultiplier" : "1.000", "CitationFlow" : "45", "TrustFlow" : "52", "RefDomains" : 4408, "ExtBackLinks" : 512226, "TopicalTrustFlow_Topic_0" : "Recreation/Food", "TopicalTrustFlow_Value_0" : "52", "TopicalTrustFlow_Topic_1" : "Business/Transportation and Logistics", "TopicalTrustFlow_Value_1" : "31", "TopicalTrustFlow_Topic_2" : "Business", "TopicalTrustFlow_Value_2" : "30" },
				{ "RankID" : 2, "Item" : "http://www.majesticseo.com/", "Title" : "Majestic®: Marketing Search Engine and SEO Backlink Checker", "SearchScore" : 4945, "ScoreInTitle" : 115, "ScoreInURL" : 0, "ScoreInAnchor" : 4471, "ScoreOther" : 359, "ScoreMultiplier" : "1.000", "CitationFlow" : "49", "TrustFlow" : "38", "RefDomains" : 19456, "ExtBackLinks" : 4537099, "TopicalTrustFlow_Topic_0" : "Computers/Internet/Web Design and Development", "TopicalTrustFlow_Value_0" : "34", "TopicalTrustFlow_Topic_1" : "Computers/Internet/On the Web", "TopicalTrustFlow_Value_1" : "32", "TopicalTrustFlow_Topic_2" : "News/Newspapers", "TopicalTrustFlow_Value_2" : "32" },
				{ "RankID" : 3, "Item" : "http://majestic12.co.uk/bot.php", "Title" : "Majestic-12 : DSearch : MJ12bot", "SearchScore" : 3691, "ScoreInTitle" : 290, "ScoreInURL" : 0, "ScoreInAnchor" : 3013, "ScoreOther" : 388, "ScoreMultiplier" : "1.000", "CitationFlow" : "58", "TrustFlow" : "40", "RefDomains" : 86787, "ExtBackLinks" : 3985311, "TopicalTrustFlow_Topic_0" : "Computers/Software/Operating Systems", "TopicalTrustFlow_Value_0" : "37", "TopicalTrustFlow_Topic_1" : "Computers/Internet/Web Design and Development", "TopicalTrustFlow_Value_1" : "32", "TopicalTrustFlow_Topic_2" : "Computers/Internet/On the Web", "TopicalTrustFlow_Value_2" : "32" },
				{ "RankID" : 4, "Item" : "https://twitter.com/Majestic/", "Title" : "Majestic (@Majestic) | Twitter", "SearchScore" : 3435, "ScoreInTitle" : 197, "ScoreInURL" : 296, "ScoreInAnchor" : 2310, "ScoreOther" : 632, "ScoreMultiplier" : "1.000", "CitationFlow" : "55", "TrustFlow" : "32", "RefDomains" : 253, "ExtBackLinks" : 693095, "TopicalTrustFlow_Topic_0" : "Computers/Internet/Web Design and Development", "TopicalTrustFlow_Value_0" : "31", "TopicalTrustFlow_Topic_1" : "Computers/Computer Science/Distributed Computing", "TopicalTrustFlow_Value_1" : "27", "TopicalTrustFlow_Topic_2" : "Reference/Education", "TopicalTrustFlow_Value_2" : "27" },
				{ "RankID" : 5, "Item" : "http://www.majesticproducts.com/", "Title" : "Majestic Products: Fireplaces & Home Hearth", "SearchScore" : 3303, "ScoreInTitle" : 96, "ScoreInURL" : 0, "ScoreInAnchor" : 2987, "ScoreOther" : 220, "ScoreMultiplier" : "1.000", "CitationFlow" : "40", "TrustFlow" : "18", "RefDomains" : 1443, "ExtBackLinks" : 17131, "TopicalTrustFlow_Topic_0" : "Business", "TopicalTrustFlow_Value_0" : "18", "TopicalTrustFlow_Topic_1" : "Business/Construction and Maintenance", "TopicalTrustFlow_Value_1" : "14", "TopicalTrustFlow_Topic_2" : "Business/Automotive", "TopicalTrustFlow_Value_2" : "13" },
				{ "RankID" : 6, "Item" : "http://www.majesticathletic.com/", "Title" : "Majestic Athletic Store: Shop Majestic Jerseys, Apparel, & Clothing", "SearchScore" : 3101, "ScoreInTitle" : 78, "ScoreInURL" : 0, "ScoreInAnchor" : 2711, "ScoreOther" : 312, "ScoreMultiplier" : "1.000", "CitationFlow" : "41", "TrustFlow" : "30", "RefDomains" : 2595, "ExtBackLinks" : 135535, "TopicalTrustFlow_Topic_0" : "Sports/Events", "TopicalTrustFlow_Value_0" : "28", "TopicalTrustFlow_Topic_1" : "Sports/Multi-Sports", "TopicalTrustFlow_Value_1" : "26", "TopicalTrustFlow_Topic_2" : "Sports/Softball", "TopicalTrustFlow_Value_2" : "24" },
				{ "RankID" : 7, "Item" : "http://majesticmadison.com/", "Title" : "Majestic Theatre | Madison, WI", "SearchScore" : 3057, "ScoreInTitle" : 141, "ScoreInURL" : 0, "ScoreInAnchor" : 2643, "ScoreOther" : 273, "ScoreMultiplier" : "1.000", "CitationFlow" : "42", "TrustFlow" : "30", "RefDomains" : 841, "ExtBackLinks" : 64334, "TopicalTrustFlow_Topic_0" : "Reference/Education", "TopicalTrustFlow_Value_0" : "28", "TopicalTrustFlow_Topic_1" : "Society/Government", "TopicalTrustFlow_Value_1" : "25", "TopicalTrustFlow_Topic_2" : "Recreation/Travel", "TopicalTrustFlow_Value_2" : "25" },
				{ "RankID" : 8, "Item" : "http://majestic.dallasculture.org/", "Title" : "The Majestic Theatre – Official Site", "SearchScore" : 3015, "ScoreInTitle" : 124, "ScoreInURL" : 413, "ScoreInAnchor" : 2142, "ScoreOther" : 336, "ScoreMultiplier" : "1.000", "CitationFlow" : "41", "TrustFlow" : "38", "RefDomains" : 854, "ExtBackLinks" : 7759, "TopicalTrustFlow_Topic_0" : "Arts/Music", "TopicalTrustFlow_Value_0" : "38", "TopicalTrustFlow_Topic_1" : "Business/Transportation and Logistics", "TopicalTrustFlow_Value_1" : "30", "TopicalTrustFlow_Topic_2" : "Society/Government", "TopicalTrustFlow_Value_2" : "30" },
				{ "RankID" : 9, "Item" : "http://www.majestic.sk/", "Title" : "Úvod | Majestic Music Club", "SearchScore" : 2986, "ScoreInTitle" : 107, "ScoreInURL" : 929, "ScoreInAnchor" : 1746, "ScoreOther" : 204, "ScoreMultiplier" : "1.000", "CitationFlow" : "38", "TrustFlow" : "20", "RefDomains" : 506, "ExtBackLinks" : 135023, "TopicalTrustFlow_Topic_0" : "Arts/Music", "TopicalTrustFlow_Value_0" : "20", "TopicalTrustFlow_Topic_1" : "Recreation/Travel", "TopicalTrustFlow_Value_1" : "15", "TopicalTrustFlow_Topic_2" : "Computers/Internet/Searching", "TopicalTrustFlow_Value_2" : "10" }
			]
			},
		"MiscInfo" : {
			"Headers" : {
			},
			"Data" : [
				{ "Name" : "FirstResultScoreTotal", "Value" : 12415, "Type" : 0 },
				{ "Name" : "FirstResultScoreInTitle", "Value" : 148, "Type" : 0 },
				{ "Name" : "FirstResultScoreInURL", "Value" : 2377, "Type" : 0 },
				{ "Name" : "FirstResultScoreInAnchor", "Value" : 9434, "Type" : 0 },
				{ "Name" : "FirstResultScoreOther", "Value" : 456, "Type" : 0 },
				{ "Name" : "FirstResultScoreMultiplier", "Value" : "1.000", "Type" : 1 }
			]
			}
		}
}

Returned values

Return value Description
Global variables
Code Code indicating if this command executed successfully.
ErrorMessage A message explaining the error. This will be blank if the code is "OK".
FullError Verbose explanation of error.
IndexBuildDate Date/time the index that was queried was last updated.
IndexType Indicates if the index was Historic (0) or Fresh (1).
ServerBuild Date/time the server was built.
ServerName Name of the server queried.
ServerVersion Version of the server queried.
UniqueIndexID Unique identifier for the index consisting of the date and index type.
Headers
Count Number of items returned by this command.
From The first result which this command returns.
GeoTarget Location where the command was called from.
GeoTargetSource IP address where the command was called from.
Matches Number of total matches for this search.
MatchesAfterFilter Number of matches after the filter is applied.
MaxTargetTopics Maximum number of topics returned.
MaxTargetTopicsRootDomains Maximum number of topics returned for root domains.
MaxTargetTopicsSubDomains Maximum number of topics returned for subdomains.
MaxTargetTopicsURLs Maximum number of topics returned for URLs.
Query Keyword queried.
Scope The value that the parameter scope was defined as.
TargetTopicsCount Number of topics for the target.
Data
RankID Position of result.
Item URL of result.
SearchScore Unique metric scoring the result in terms of relevance.
ScoreInTitle Score for the item's title.
ScoreInURL Score for the item's URL.
ScoreInAnchor Score for the item's anchor text.
ScoreOther Score for other factors.
ScoreMultiplier Amount that the score is multiplied by.
CitationFlow CitationFlow value for this item.
TrustFlow TrustFlow value for this item.
RefDomains Number of domains that refer to this item.
ExtBackLinks Number of external backlinks to this item.
TopicalTrustFlow_Topic_x TopicalTrustFlow topic for this item.
TopicalTrustFlow_Value_x Value for the given TopicalTrustFlow topic.
MiscInfo Data
FirstResultScoreTotal Score total for the first result in the list.
FirstResultScoreInTitle Score for the title of the first result in the list.
FirstResultScoreInURL Score for the URL of the first result in the list.
FirstResultScoreInAnchor Score for the anchor text of the first result in the list.
FirstResultScoreOther Score for other factors of the first result in the list.
FirstResultScoreMultiplier Multiplier for the score of the first result in the list.

Changes

August 2018

SearchByKeyword changed to only use the 'historic' index.