Anura Docs

Anura Reporting API - Summary Filters Endpoints

Anura Reporting API - Summary Filters Endpoints - Table

The Summary Filters: Table endpoint will allow you to retrieve, or search, a list of summary filters applicable to the supplied POST parameters.

Parameters

Example Response

{
    "table": {
        "headers": [
            "Name",
            "User",
            "Type",
            "Shared",
            "Created"
        ],
        "rows": [
             {
                 "id": "4ayAX5r3",
                 "name": "Good%20Vibes",
                 "type": "script",
                 "shared": true,
                 "modifiable": true,
                 "created": {
                     "date": "2026-10-02T16:04:44+00:00",
                     "method": "dashboard",
                     "user": "Anura%20User"
                 },
                 "last_updated": {
                     "date": "2026-10-02T18:22:36+00:00",
                     "method": "dashboard",
                     "user": "Anura%20User"
                 }
             },
             {
                 "id": "TqPSA3T3",
                 "name": "Suspect%20Traffic",
                 "type": "direct",
                 "shared": false,
                 "modifiable": true,
                 "created": {
                     "date": "2026-10-04T12:28:20+00:00",
                     "method": "api",
                     "user": "Anura%20User"
                 },
                 "last_updated": null
             }
        ]
    },
    "query": {
        "type": false,
        "shared": false,
        "search": false,
        "startswith": false,
        "sort": "0:asc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Summary Filters Endpoints - Filter

The Summary Filters: Filter endpoint will allow you to retrieve detailed summary filter specific information applicable to the supplied POST parameters.

Parameters

Example Response

{
    "id": "4ayAX5r3",
    "name": "Good%20Vibes",
    "type": "script",
    "shared": true,
    "modifiable": true,
    "created": {
        "date": "2026-10-02T16:04:44+00:00",
        "method": "dashboard",
        "user": "Anura%20User"
    },
    "last_updated": {
        "date": "2026-10-02T18:22:36+00:00",
        "method": "dashboard",
        "user": "Anura%20User"
    },
    "filters": [
        [
            {
                "column": "responses",
                "operator": "greater_than_equal_to",
                "value": 1000
            },
            {
                "column": "good_rate",
                "operator": "greater_than_equal_to",
                "value": 80.00
            }
        ]
    ]
}

Anura Reporting API - Summary Filters Endpoints - Create

The Summary Filters: Create endpoint will allow you to create a new summary filter using the supplied POST parameters.

Parameters

Filter Groups and Filter Objects

Summary filters are structured as an array of one or more "filter group" arrays containing "filter objects."

• Filter objects are used to provide constraints for your query, each defining their own column, operator, and value.
• Filter groups allow for multiple sets of constraints to be applied at the same time.
• Filter groups are combined using OR statements while each filter object in the group is combined using AND statements.

[
    [
        {
            "column": "requests",
            "operator": "greater_than",
            "value": 5000
        },
        {
            "column": "good_rate",
            "operator": "less_than_equal_to",
            "value": 30.00
        }
    ],
    [
        {
            "column": "responses",
            "operator": "greater_than",
            "value": 2000
        },
        {
            "column": "warning_rate",
            "operator": "greater_than_equal_to",
            "value": 80.00
        }
    ]
]

WHERE (requests > 5000 AND good_rate <= 30.00) OR (responses > 2000 AND warning_rate >= 80.00)

There are no restrictions to the number of filter groups or filter objects you can use to filter your summary data. However, be mindful not to apply too many constraints as the result set may be reduced in an undesirable manner.

Script Columns

The following columns can be used when filtering Script summary data.

Direct Columns

The following columns can be used when filtering Direct summary data.

Summary Filter Operators

Operators are the comparison mechanism(s) used when filtering summary data. String values have a different set of operators than integers and floats, which are shown in the following table.

Example Request

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiIxMjMiLCJpYXQiOjE2NjE5OTIwODAsImp0aSI6ImlPYVNOQW10UmhZU3l2MXQ5eDkiLCJhdWQiOiIwbVglMkZSJTJCTWdBS2xteSIsInRrbiI6ImFwaSJ9.SC8PtaQetBwGBu56J0yyUtqVEL",
    "name": "My%20First%20Summary%20Filter",
    "type": "script",
    "filters": [
        [
            {
                "column": "responses",
                "operator": "greater_than",
                "value": 999
            },
            {
                "column": "good_rate",
                "operator": "less_than",
                "value": 33.33
            }
        ]
    ]
}

Example Response

{
    "success": true,
    "message": "%22My%20First%20Summary%20Filter%22%20has%20been%20created",
    "feedback": {
        "pass": {},
        "fail": {}
    },
    "id": "QFJnsd5g"
}

Anura Reporting API - Summary Filters Endpoints - Update

The Summary Filters: Update endpoint will allow you to update a previously created summary filter applicable to the supplied POST parameters.

Parameters

At least one optional parameter is required. Only the posted parameter(s) will be updated.

Example Request

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiIxMjMiLCJpYXQiOjE2NjE5OTIwODAsImp0aSI6ImlPYVNOQW10UmhZU3l2MXQ5eDkiLCJhdWQiOiIwbVglMkZSJTJCTWdBS2xteSIsInRrbiI6ImFwaSJ9.SC8PtaQetBwGBu56J0yyUtqVEL",
    "filter": "QFJnsd5g",
    "filters": [
        [
            {
                "column": "responses",
                "operator": "greater_than_equal_to",
                "value": 1000
            },
            {
                "column": "good_rate",
                "operator": "less_than_equal_to",
                "value": 33.55
            }
        ]
    ],
    "shared": true
}

Example Response

{
    "success": true,
    "message": "%22My%20First%20Summary%20Filter%22%20has%20been%20updated",
    "feedback": {
        "pass": {},
        "fail": {}
    }
}

Anura Reporting API - Summary Filters Endpoints - Remove

The Summary Filters: Remove endpoint will allow you to remove modifiable summary filters applicable to the supplied POST parameters.

Parameters

Example Response

{
    "success": true,
    "message": "%22My%20First%20Summary%20Filter%22%20has%20been%20removed",
    "feedback": {
        "pass": {},
        "fail": {}
    }
}