Filter by profile data

To select users based on profile data, define a filter object in the pool parameters.

Sample filter in JSON

This example selects users who set their country as Russia and the city as Moscow in the profile.

{
  "filter" : {
    "and" : [ {
      "or" : [ {
        "category" : "profile",
        "key" : "country",
        "operator" : "EQ",
        "value" : "RU"
      } ]
    }, {
      "or" : [ {
        "category" : "profile",
        "key" : "city",
        "value" : 213,
        "operator" : "IN"
      } ]
    } ]
  }
}
Copied to clipboard

Key and value parameters


Key parameter	Value description
gender	string The user's gender: “MALE” — Male. “FEMALE” — Female. Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
country	string The user's country of residence (the two-letter code from the ISO 3166-1 alpha-2 standard). Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
citizenship	string The user's country of citizenship (the two-letter code from the ISO 3166-1 alpha-2 standard). Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
education	string The user's level of education: “BASIC” — Secondary education (high school). “MIDDLE” — Specialized secondary education (vocational school). “HIGH” — Post-secondary education (university). Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
adult_allowed	boolean The user agrees to perform tasks that contain adult content. Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
date_of_birth	integer The user's date of birth (UNIX time in seconds). Value of "operator": `EQ` — Equal to. `NE` — Not equal to. `GT` — Greater than. `LT` — Less than. `GTE` — Greater than or equal to. `LTE` — Less than or equal to.
city	integer The user's city (the region ID in the search database). Value of "operator": `IN` — Contained in the list of regions or languages in the profile. `NOT_IN` — Not contained in the list of regions or languages in the profile.
languages	string The languages the user entered in the profile (uppercase two-letter ISO code conforming to ISO 639-1). Value of "operator": `IN` — Contained in the list of regions or languages in the profile. `NOT_IN` — Not contained in the list of regions or languages in the profile.


Key parameter	Value description
gender	string The user's gender: “MALE” — Male. “FEMALE” — Female. Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
country	string The user's country of residence (the two-letter code from the ISO 3166-1 alpha-2 standard). Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
citizenship	string The user's country of citizenship (the two-letter code from the ISO 3166-1 alpha-2 standard). Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
education	string The user's level of education: “BASIC” — Secondary education (high school). “MIDDLE” — Specialized secondary education (vocational school). “HIGH” — Post-secondary education (university). Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
adult_allowed	boolean The user agrees to perform tasks that contain adult content. Value of "operator": `EQ` — Equal to. `NE` — Not equal to.
date_of_birth	integer The user's date of birth (UNIX time in seconds). Value of "operator": `EQ` — Equal to. `NE` — Not equal to. `GT` — Greater than. `LT` — Less than. `GTE` — Greater than or equal to. `LTE` — Less than or equal to.
city	integer The user's city (the region ID in the search database). Value of "operator": `IN` — Contained in the list of regions or languages in the profile. `NOT_IN` — Not contained in the list of regions or languages in the profile.
languages	string The languages the user entered in the profile (uppercase two-letter ISO code conforming to ISO 639-1). Value of "operator": `IN` — Contained in the list of regions or languages in the profile. `NOT_IN` — Not contained in the list of regions or languages in the profile.