Here you will find all the necessary information about filters that can be used with Business Listings API.
Note that filters are associated with a certain object in the result array, and should be specified accordingly.
Your account will not be charged for using this API
GET
You will receive the full list of filters by calling this API.
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
| Field name | Type | Description |
|---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
id |
string | task identifier unique task identifier in our system in the UUID format |
status_code |
integer | status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here |
status_message |
string | informational message of the task you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the result array |
path |
array | URL path |
data |
object | contains the parameters passed in the URL of the GET request |
result |
array | array of results contains the full list of available parameters that can be used for data filtration the parameters are grouped by the endpoint they can be used with |
Below you will find a detailed description of the structure that should be used to specify filters for Domain Analytics Whois API. You will also find the types of parameters that can be used with each endpoint, and examples of pre-made filters.
Description of the fields:
| Field name | Type | Description |
|---|---|---|
filters |
array | array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditionsfilters have the following structure: [$results_array.$parameter_field, $filter_operator, $filter_value]you should use the . and , characters as separatorsexample: ["rating.value",">",3] |
$results_array |
str | results array in the filter optional field possible values: address_info, rating |
$parameter_field |
str | parameter field in the filter optional field required field if the filter is applied the parameter in the superordinate $results_arrayrepresents the field you want to filter the results by |
$filter_operator |
str | operator in the filter optional field required field if the filter is applied available filter operators: • if bool: =, <>• if num: <, <=, >, >=, =, <>, in, not_in• if str: like, not_like, ilike, not_ilike, in, not_in, =, <>, regex, not_regex, match, not_match• if array.str: has, has_not• if time: <, >time should be specified in the format: “yyyy-mm-dd hh-mm-ss +00:00”example: 2021-01-29 15:02:37 +00:00
if you specify
|
$filter_value |
num str bool array.str |
filtering value optional field required field if the filter is applied |
The list of available filtration parameters:
{
"version": "0.1.20250515",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.0511 sec.",
"cost": 0,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"id": "05201656-1535-0550-0000-2a8d7ce25fe5",
"status_code": 20000,
"status_message": "Ok.",
"time": "0 sec.",
"cost": 0,
"result_count": 1,
"path": [
"v3",
"business_data",
"business_listings",
"available_filters"
],
"data": {
"api": "business_data",
"function": "available_filters",
"se": "business_listings"
},
"result": [
{
"search": {
"title": "str",
"description": "str",
"category": "str",
"category_ids": "array.str",
"additional_categories": "array.str",
"cid": "str",
"feature_id": "str",
"address": "str",
"address_info.borough": "str",
"address_info.address": "str",
"address_info.city": "str",
"address_info.zip": "str",
"address_info.region": "str",
"address_info.country_code": "str",
"place_id": "str",
"phone": "str",
"url": "str",
"domain": "str",
"logo": "str",
"main_image": "str",
"total_photos": "num",
"snippet": "str",
"latitude": "num",
"longitude": "num",
"is_claimed": "bool",
"rating.rating_type": "str",
"rating.value": "num",
"rating.votes_count": "num",
"rating.rating_max": "num",
"rating_distribution.1": "num",
"rating_distribution.2": "num",
"rating_distribution.3": "num",
"rating_distribution.4": "num",
"rating_distribution.5": "num",
"work_time.work_hours.current_status": "str",
"check_url": "str",
"last_updated_time": "time",
"price_level": "str",
"hotel_rating": "num",
"contact_info.type": "str",
"first_seen": "time"
},
"categories_aggregation": {
"title": "str",
"description": "str",
"category": "str",
"category_ids": "array.str",
"additional_categories": "array.str",
"cid": "str",
"feature_id": "str",
"address": "str",
"address_info.borough": "str",
"address_info.address": "str",
"address_info.city": "str",
"address_info.zip": "str",
"address_info.region": "str",
"address_info.country_code": "str",
"place_id": "str",
"phone": "str",
"url": "str",
"domain": "str",
"logo": "str",
"main_image": "str",
"total_photos": "num",
"snippet": "str",
"latitude": "num",
"longitude": "num",
"is_claimed": "bool",
"rating.rating_type": "str",
"rating.value": "num",
"rating.votes_count": "num",
"rating.rating_max": "num",
"rating_distribution.1": "num",
"rating_distribution.2": "num",
"rating_distribution.3": "num",
"rating_distribution.4": "num",
"rating_distribution.5": "num",
"work_time.work_hours.current_status": "str",
"check_url": "str",
"last_updated_time": "time",
"price_level": "str",
"hotel_rating": "num",
"contact_info.type": "str",
"first_seen": "time"
}
}
]
}
]
}