Retrieve a keyword
URL
https://api.zoomrank.com/users/:user_id/mobile/keywords/:id.xml
Supported formats
xml, json
Supported request methods
GET
Example
Retrieve keyword with ZoomRank ID 1 for user with ZoomRank ID 5.
https://api.zoomrank.com/users/5/mobile/keywords/1.xml
Response Codes
200
- Success404
- No records found
Mobile Keyword Object
Field | Description | Format |
---|---|---|
external_id | Your unique identifier | char(125) |
category_id | ZoomRank Category ID | int |
url | URL | char(255) |
keyword | Phrase/keyword | char(100) |
location | The city and state to perform ranking from | City,ST (example: Dallas,TX) |
exact | URL must be an exact match. | 1 or 0 (True/False - Default is 0) |
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 (JSON)
{ "keyword":{ "id":7, "engine_id":1, "external_id":"MYUNIQUEKEY1", "category_id":1, "url":"www.eatjoespizza.com", "keyword":"pizza", "location":"Frisco,TX", "ranking_dow":null, "ranking_dom":1, "last_ranked_date":"2013-08-30", "ranking":{ "id":18, "date":"2013-08-30", "engine_id":1, "url":"eatjoespizza.com", "page":1, "rank":2, "change":-1, "local_rank":2, "local_change":1 } } }
Example Response (XML)
<keyword id="7"> <external_id>MYUNIQUEKEY1</external_id> <engine_id>1</engine_id> <category_id>1</category_id> <url>www.eatjoespizza.com</url> <keyword>pizza</keyword> <location>Frisco,TX</location> <ranking_dow></ranking_dow> <ranking_dom>1</ranking_dom> <last_ranked_date>2013-08-30</last_ranked_date> <ranking id="18" engine_id="1"> <date>2013-08-30</date> <number_of_results>402000000</number_of_results> <url></url> <page>1</page> <rank>2</rank> <change>-1</change> <local_rank>2</local_rank> <local_change>1</local_change> </ranking> </keyword>