< Back to zoomrank.com

Retrieve a keyword

URL

https://api.zoomrank.com/users/:user_id/local/listings/:listing_id/keywords/:id.xml

Supported formats

xml, json

Supported request methods

GET

Example

Retrieve keyword with ZoomRank ID 1 for listing with ZoomRank ID 1200.

https://api.zoomrank.com/users/1/local/listings/1200/keywords/1.xml

Response Codes

200 - Success
404 - No records found

Local Keyword Object

Field Description Format
category_id ZoomRank Category ID int
external_id Your unique identifier char(125)
keyword Phrase/keyword char(100)
location The city and state to perform ranking from City,ST (example: Dallas,TX)
ranking_dow Weekly ranking day-of-week 0 - 6 (0 = Sunday)
ranking_dom Monthly ranking day 1 - 28
last_ranked_date Date of which record was last ranked YYYY-MM-DD

Example Response

<keyword id="24">
	<external_id/>
	<category_id/>
	<keyword>pizza frisco</keyword>
	<location>Dallas,TX</location>
	<last_ranked_date>2011-03-25</last_ranked_date>
	<rankings>
		<ranking id="18" engine_id="1">
			<date>2011-03-25</date>
			<number_of_results>9942</number_of_results>
			<page>1</page>
			<rank>1</rank>
			<change/>
		</ranking>
	</rankings>
</keyword>