Request - Raw Data Endpoints - Anura Reporting API

Anura Reporting API - Raw Data Endpoints - Request

The Raw Data: Request endpoint will allow you to generate a new report applicable to the supplied POST parameters.

Method	URL
POST	https://api.anura.io/v1/raw/request

Parameters

Required	Type	Description	Note
token	string	The token string you have been issued to connect to the Anura Reporting API.
type	string	The type of Raw Data report being requested.	Acceptable values: request, response, direct.
instance	string	The ID of the instance for which Raw Data will be returned.
start	integer	The starting date from which Raw Data will be returned.	Date format: YYYYMMDD. No more than 90 days old.
end	integer	The ending date to which Raw Data will be returned.	Date format: YYYYMMDD. Not greater than today.
standard	array	An array of Standard Data columns to be returned.	At least one Standard Data column is required. See the table below for acceptable columns.

Optional	Type	Description	Note
name	string	A descriptive name, or title, for your report.	A report name is generated automatically when no value is submitted.
additional	array	An array of Additional Data columns to be returned.	Referenced by number. An array of [1, 3, 5] should be submitted for Additional Data columns 1, 3, and 5 respectively.
filters	array	An array of objects, consisting of a column, operator, and value, that are used to narrow results when generating reports.	Standard and Additional data columns must be present to be filtered. See below for more information regarding filter objects and operators.
send_email	boolean	Send an email alert when your Raw Data report has finished generating.	True by default.

Limitations

Please be aware of the following processing limitations when requesting Raw Data reports:

Accounts are limited to 360 total minutes of data processing per day - across all users.
Users may request up to two concurrent reports at a time via the Anura Dashboard interface.
Users may only request one report at a time via the Anura API.
Processing time is rounded up to the minute.

Data processing limitations are default values and can be modified. Talk to support if you're encountering issues with the default limitations.

Standard Data Columns

Report Type	Acceptable Columns
request	source campaign exid remote_address network connection country region city user_agent browser_name browser_version os_name os_version device_type device_manufacturer device_model location
response	source campaign response_id result rule_sets invalid_traffic_type remote_address network connection country region city language user_agent browser_name browser_version os_name os_version device_type device_manufacturer device_model page referrer
direct	source campaign result rule_sets invalid_traffic_type remote_address network connection country region city user_agent device_type browser_name browser_version os_name os_version device_manufacturer device_model app_id device_id requesting_remote_address requesting_user_agent

Filter Objects

A filter is an object consisting of a column, operator, and value, that is used to narrow the number of results in a report. Multiple filters may be applied to a request; however, a column may only be filtered once.

Example Filters Array

"filters": [
    {
        "column": "source",
        "operator": "conatins",
        "value": "hello"
    }
]

The above example illustrates a filter object on the source column where the value contains "hello".

Filter Operators

Operators are the comparison mechanism used when narrowing report results. Most operators can be used against any column, however, there are a few special cases to be aware of. Available operators and their special cases can be found in the following tables.

Column Type	Column	Available Operators	Note
Standard Data	All standard data columns except for special cases, listed below.	equals, not_equals, contains, not_contains
Additional Data	Numeric value (1-10 default)	equals, not_equals, contains, not_contains, empty, not_empty	Value is not applied when using empty and not_empty operators.

Special Case Operators

Report Type	Column	Available Operators	Note
request	result	None Available	Acceptable values: "with-responses" and "drops".
response	result	equals, not_equals	Acceptable values: "good", "warning", and "bad".
direct	result	equals, not_equals	Acceptable values: "non-suspect" and "suspect".
request	exid	equals, not_equals, contains, not_contains, empty, not_empty	Value is not applied when using empty and not_empty operators.
direct	app_id	equals, not_equals, contains, not_contains, empty, not_empty	Value is not applied when using empty and not_empty operators.
direct	device_id	equals, not_equals, contains, not_contains, empty, not_empty	Value is not applied when using empty and not_empty operators.

Example Request

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiIxMjMiLCJpYXQiOjE2NjE5OTIwODAsImp0aSI6ImlPYVNOQW10UmhZU3l2MXQ5eDkiLCJhdWQiOiIwbVglMkZSJTJCTWdBS2xteSIsInRrbiI6ImFwaSJ9.SC8PtaQetBwGBu56J0yyUtqVEL",
    "type": "response",
    "instance": 1234567890,
    "start": 20220918,
    "end": 20220924,
    "standard": [
        "source",
        "campaign",
        "response_id",
        "result",
        "remote_address",
        "network",
        "country",
        "region",
        "city",
        "user_agent",
        "browser_name",
        "browser_version",
        "os_name",
        "os_version",
        "device_type"
    ],
    "name": "My%20First%20Raw%20Data%20Report",
    "additional": [
        1,
        3,
        5
    ],
    "filters": [
        {
            "column": "source",
            "operator": "contains",
            "value": "hello"
        },
        {
            "column": "campaign",
            "operator": "contains",
            "value": "world"
        }
    ],
    "send_email": false
}

Example Response

{
    "success": true,
    "message": "Your+raw+data+report+has+been+requested",
    "feedback": {
        "pass": {},
        "fail": {}
    },
    "id": "mnUeFVP0"
}