Filters for Domain Analytics Whois API

‌‌
Here you will find all the necessary information about filters that can be used with Domain Analytics Whois API.

Note that filters are associated with a certain object in the result array, and should be specified accordingly.

Pricing

Your account will not be charged for using this API

checked GET

You will receive the full list of filters by calling this API. You can also download the full list of possible filters by this link.

‌‌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 nameTypeDescription
versionstring

the current version of the API

status_codeinteger

general status code
you can find the full list of the response codes here

status_messagestring

general informational message
you can find the full list of general informational messages here

timestring

execution time, seconds

costfloat

total tasks cost, USD

tasks_countinteger

the number of tasks in the tasks array

tasks_errorinteger

the number of tasks in the tasks array returned with an error

tasksarray

array of tasks

    idstring

task identifier
unique task identifier in our system in the UUID format

    status_codeinteger

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_messagestring

informational message of the task
you can find the full list of general informational messages here

    timestring

execution time, seconds

    costfloat

cost of the task, USD

    result_countinteger

number of elements in the result array

    patharray

URL path

    dataobject

contains the parameters passed in the URL of the GET request

    resultarray

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 nameTypeDescription
filtersarray

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 conditions
filters have the following structure:
[$item_array.$results_array.$parameter_field, $filter_operator, $filter_value]
you should use the . and , characters as separators
example:
["metrics.organic.pos_1", ">=", 50]

    $item_arraystr

item name in the filter
optional field
possible values:
keyword_data, ranked_serp_element

    $results_arraystr

results array in the filter
optional field
possible values:
keyword, keyword_info, check_url, se_results_count, serp_item, metrics

    $parameter_fieldstr

parameter field in the filter
optional field
required field if the filter is applied
the parameter in the superordinate $results_array or item_array
represents the field you want to filter the results by

    $filter_operatorstr

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, in, not_in, =, <>, regex, not_regex
• if array.str: has, has_not
• if array.num: 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 in or not_in operator, the $filter_value should be specified as an array;
example:
["metrics.organic.etv","in",[10,100]]

regex and not_regex operator can be specified with string values using the RE2 regex syntax;
Note: the maximum limit for the number of characters you can specify in regex and not_regex is 1000;

like and not_like operators require adding % character to get accurate results;
example:
["domain", "like", "%seo%"] return keyword_data items that contain “seo” in the domain field
["domain", "not_like", "%seo%"] do not return domains that contain “seo”

    $filter_valuenum str bool array.str

filtering value
optional field
required field if the filter is applied

    available_filtersnum str bool

the list of available filters for the Domain Analytics Whois Overview endpoint:
["domain", "like", "%seo%"]
["expiration_datetime",">","2021-02-15 01:00:00 +00:00"]
["created_datetime","<","2019-03-15 01:00:00 +00:00"]
["registered","=",true]
["tld","=","com"]
["metrics.organic.etv",">",100]
["metrics.paid.etv",">",0]
You can get the full list of possible filters by this link


‌‌

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access

The list of available filtration parameters:

{
    "version": "0.1.20220819",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.0594 sec.",
    "cost": 0,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "10191600-1535-0493-0000-443468ba069f",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0 sec.",
            "cost": 0,
            "result_count": 1,
            "path": [
                "v3",
                "domain_analytics",
                "whois",
                "available_filters"
            ],
            "data": {
                "api": "domain_analytics",
                "function": "available_filters",
                "se": "whois"
            },
            "result": [
                {
                    "overview": {
                        "domain": "str",
                        "created_datetime": "time",
                        "changed_datetime": "time",
                        "expiration_datetime": "time",
                        "updated_datetime": "time",
                        "epp_status_codes": "array.str",
                        "tld": "str",
                        "registered": "bool",
                        "registrar": "str",
                        "metrics.paid.pos_1": "num",
                        "metrics.paid.pos_2_3": "num",
                        "metrics.paid.pos_4_10": "num",
                        "metrics.paid.pos_11_20": "num",
                        "metrics.paid.pos_21_30": "num",
                        "metrics.paid.pos_31_40": "num",
                        "metrics.paid.pos_41_50": "num",
                        "metrics.paid.pos_51_60": "num",
                        "metrics.paid.pos_61_70": "num",
                        "metrics.paid.pos_71_80": "num",
                        "metrics.paid.pos_81_90": "num",
                        "metrics.paid.pos_91_100": "num",
                        "metrics.paid.etv": "num",
                        "metrics.paid.count": "num",
                        "metrics.paid.estimated_paid_traffic_cost": "num",
                        "metrics.organic.pos_1": "num",
                        "metrics.organic.pos_2_3": "num",
                        "metrics.organic.pos_4_10": "num",
                        "metrics.organic.pos_11_20": "num",
                        "metrics.organic.pos_21_30": "num",
                        "metrics.organic.pos_31_40": "num",
                        "metrics.organic.pos_41_50": "num",
                        "metrics.organic.pos_51_60": "num",
                        "metrics.organic.pos_61_70": "num",
                        "metrics.organic.pos_71_80": "num",
                        "metrics.organic.pos_81_90": "num",
                        "metrics.organic.pos_91_100": "num",
                        "metrics.organic.etv": "num",
                        "metrics.organic.count": "num",
                        "metrics.organic.estimated_paid_traffic_cost": "num"
                    }
                }
            ]
        }
    ]
}