< Back to zoomrank.com

Create Keyword

URL

http://vendor.zoomrank.com/accounts/:account_id/keywords.json

Supported formats

JSON

Supported request methods

POST

Example

Create a new keyword for account ID 1

http://vendor.zoomrank.com/accounts/1/keywords.json

Arguments

Argument Description Format
keyword The JSON object for the new keyword (See example request) JSON

Keyword Object

Field Description Format
external_id Your unique identifier char(125)
engine_id Search engine ID 1 = Google
2 = Yahoo
3 = Bing
term Search term
mobile mobile or SERP true = mobile keyword
false = SERP keyword
country Country See Supported Countries
language Language (Google Only) See Supported Languages
location Search Location (Google Only) City,ST
dow Weekly ranking day-of-week 0 - 6 (0 = Sunday)
last_processed_date Date of which record was last processed YYYY-MM-DD

Response Codes

201 - Success
400 - Bad request. See error response.
500 - Unexpected error. Try again.

Example Request (Google - Default Country/Language/Location)

{
    "external_id": "1234",
    "engine_id": 1,
    "term": "search engine ranking",
    "mobile": false
}

Example Response

{
    "id": 1,
    "external_id": "1234",
    "engine_id": 1,
    "term": "search engine ranking",
    "mobile": false,
    "country": "US",
    "language": "EN",
    "location": "Dallas,TX",
    "dow": null,
    "last_processed_date": "2012-05-01"
}