Create a SERP keyword
URL
https://api.zoomrank.com/users/:user_id/serp/keywords.xml
Supported formats
xml, json
Supported request methods
POST
Example
Create a new SERP keyword for user with ZoomRank ID 1.
https://api.zoomrank.com/users/1/serp/keywords.xml
Arguments
| Argument | Description |
|---|---|
| keyword | The new SERP keyword record sent in the request body (object details below). |
SERP Keyword Object
| Field | Description | Format |
|---|---|---|
| category_id | ZoomRank Category ID | int |
| external_id | Your unique identifier | char(125) |
| keyword | Phrase/keyword | char(100) |
| url | URL or domain to match (do not include http/https) | char(255) |
| ranking_dow | Weekly ranking day-of-week | 0 - 6 (0 = Sunday) |
| last_ranked_date | Date of which record was last ranked | YYYY-MM-DD |
SERP Keyword Engine Object
| Field | Description | Format |
|---|---|---|
| engine_id | Search engine ID |
1 = Google 2 = Yahoo 3 = Bing |
| country | Country | See Supported Countries |
| language | Language | See Supported Languages |
| location | Search Location (Google Only) | City,ST |
Considerations
- All search engines are enabled by default.
- Country will default to United States if not specified.
- Language will default to English if not specified (for supported engines).
- Location is optional and ONLY supported by Google.
Response Codes
- 201 - Success (Created)
- 400 - Bad Request (Errors occurred while creating record - See response body)
- 500 - Internal Server Error (Something bad happened, let us know!)
Example Request Body (defaults)
<keyword> <category_id>1</category_id> <external_id>U1</external_id> <url>zoomrank.com</url> <keyword>search engine rankings</keyword> </keyword>
Example Request Body (Only rank Google Canada w/ French Interface Language)
<keyword> <category_id>1</category_id> <external_id>U1</external_id> <url>zoomrank.com</url> <keyword>search engine rankings</keyword> <engines> <engine> <id>1</id> <country>CA</country> <language>FR</language> </engine> </engines> </keyword>
Example Request Body (Rank Google ONLY from San Jose, California)
<keyword> <url>dospinas.com</url> <keyword>street tacos</keyword> <engines> <engine> <id>1</id> <location>San Jose,CA</location> </engine> </engines> </keyword>