Filtering

Here you can find general information and explanation how Filters works in Senuto API. Every endpoint which allows you to to filter results is marked with Filtering!

To make requests to get filtered data using Senuto API we need to add an additional payload field - filtering.

The field of filtering is an array of Objects: filtering: [ {} ]

Each object contains a single field - filters which contain an array of FilterObject.

"filtering": [
    {
        "filters": [
            FilterObject
        ]
    }
]

One single FilterObject has the following fields: key, match, value.

"filtering": [
    {
        "filters": [
            {
                "value": "VALUE",
                "match": "MATCH",
                "key": "KEY",
            }
        ]
    }
]

Available values for key field:

statistics.position.current, statistics.visibility.current, statistics.searches.current, statistics.cpc.current

Available values for match field:

gt, gte, lt, lte, eq

Values for field value can be integer or string - depending on the context of the filter.

Use Case:

You want to get data TOP 25 keywords of your domain: see example with TOP 25

If you have any questions contact our support