Dear customers! We have updated our Privacy Policy: . An updated version of our Privacy Policy takes eff ect on May 25, 2018.

Compound fields

A compound field is a field with a value that depends on the different parameters.
The parameters are called qualifiers.

Separate value names and values of qualifiers with a colon ":" and pass them as a compound field name in an API request.
Values of qualifiers must be sorted alphabetically.

Example

Compound field example: keyword volume.
This field exists in a keyword data type.

volume field qualifiers have the following properties:

  • region_key - region key
  • searcher_key - search engine key
  • type - search volume type code

Below is an example of the fields parameter to get search volume from NYC (202), Google search engine (1), search volume type [!Keyword] (3):

{"fields":["volume:213:0:3"]}

Below is an example of using a fields parameter to get keyword search volume with the same settings as above, but to display only the data that is greater than 50:

{"filters":[{"name":"volume:213:0:3","operator":"GREATER_THAN_EQUALS","values":[50]}]}