Keywords
- A group must be assigned to a keyword, creating stray keywords missing a folder is not allowed.
Object structure: "Keywords"
| Field | Type | Description |
| Basic | ||
|---|---|---|
| id | int | group ID |
| project_id | int | project ID |
| group_id | int | folder ID |
| name | string | Group name |
| tags | set(от 1 до 10) | Tag number |
| target | string | Target link |
| ord | int | Sorting order number |
| Additional | ||
| group_name | string | Keyword group name |
| group_on | boolean | Keyword group status |
| group_ord | int | Keyword group sorting order number |
| group_folder_id | int |
ID of folder that contains a keyword group You can use it combined with a group_folder_id_depth additional parameter for filtering:
|
| group_folder_path | string | Keyword group path (without group name) |
| volume | int |
Search volume is a compound field. Field qualifiers:
|
| cost_forecast | int |
Cost-per-click is a compound field. Field qualifiers:
|
| position | int or string('--') |
Keyword rank is a compound field. Field qualifiers:
|
| relevant_url | string |
Relevant page is a compound field. It has the same qualifiers as the position field. |
| snippet_title | string |
Snippet title is a compound field. It has the same qualifiers as the position field. |
| snippet_body | string |
Snippet body is a compound field. It has the same qualifiers as the position field. |
| visitors | int |
Visits are a compound field. It has the same qualifiers as the position field Visits are collected automatically during a rank check for the projects connected to Google Analytics or Yandex Metrica. |
| COUNT(*) | int |
Returned objects count
|
Keyword methods
- get: keywords - get a list of keywords
- get: keywords/export - keyword export
- add: keywords - add a keyword
- add: keywords/add/import - keyword import
- edit: keywords/rename - rename a keyword
- edit: keywords/tags - change a keyword tag
- edit: keywords/target - assign a target link tpo a keyword
- edit: keywords/move - move keywords
- edit: keywords/sort - re-sort keywords
- edit: keywords/export/toProject - copy keywords to another project
- edit: keywords/undel - recover a keyword from a temporary bin
- del: keywords - delete a keyword