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 int 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:
  • 0 - do not search subfolders (default)
  • 1 - search subfolders
group_folder_path string Keyword group path (without group name)
volume int

Search volume is a compound field.

Field qualifiers:

  • region_key - region key
  • searcher_key - search engine key

  • type - search volume type, available values:

    For Google: 3
    For Yandex: 1, 2, 3, 5, 6 (V, "V", "!V", "[V]", "[!V]")
    For go.Mail: 2
cost_forecast int

Cost-per-click is a compound field.

Field qualifiers:

  • position - Ad position, available values:

    Yandex: Google:
    • P11 - 1 place
    • P1L - Page top
    • P2L - 1 page

    • P11 - 1st position in premium placement
    • P12 - 2nd position premium placement
    • P13 - 3rd position premium placement
    • P1L - Premium placement entry
    • P21 - 1st position (in the guaranteed placement block)
    • P2L - Guaranteed placement

  • region_key - region key
  • searcher_key - search engine key
position int or string('--')

Keyword rank is a compound field.

Field qualifiers:

  • date - date of check
  • region_index - region index
relevant_url int

Relevant page 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

  • Do not use with the other fields
  • Returns a single field

Keyword methods

FAQ