Anura Docs

Anura Reporting API - Raw Data Endpoints

The following Raw Data endpoints are available in the current version of the Anura Reporting API.

Anura Reporting API - Raw Data Endpoints - Table

The Raw Data: Table endpoint will allow you to retrieve, or search, a list of self-generated reports applicable to the supplied POST parameters.

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

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
Optional Type Description Note
search string A value to which results will be limited. Results are returned based on a broad match of the declared value.
startswith boolean Set true to return only results starting with the search value. False by default.
sort string The order in which results will be returned. Up to 3 valid comma separated sortings may be requested. Format: column:asc or column:desc. "3:desc" is returned by default.
page integer The page of results to be returned. Page 1 is returned by default.
limit integer The number of returned results. 20 results are returned by default. 1,000 results max.
processing_usage boolean Set true to return a detailed breakdown of account processing usage. False by default. Admin users only.

Example Response

{
    "processing": {
        "limits": {
            "minutes_total": 900,
            "api_concurrent": 1,
            "dashboard_concurrent": 2,
            "minutes_available": 888
        }
    },
    "table": {
        "rows": [
            {
                "id": "kuDZdF6v",
                "name": "Anura+Raw+Response+Report+20220924",
                "instance": "yourInstanceName",
                "type": "Response",
                "requested": "2022-09-24 13:22:31",
                "created": null,
                "failed": null,
                "timed_out": null,
                "cancelled": null,
                "status": "In Progress",
                "expires": "2022-10-25 00:00:00"
            },
            {
                "id": "JpTxDnu4",
                "name": "Anura+Raw+Request+Report+20220924",
                "instance": "yourInstanceName",
                "type": "Request",
                "requested": "2022-09-24 13:16:19",
                "created": "2022-09-24 13:17:28",
                "failed": null,
                "timed_out": null,
                "cancelled": null,
                "status": "Ready",
                "expires": "2022-10-25 00:00:00"
            }
        ]
    },
    "query": {
        "search": false,
        "sort": "3:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1,
        "processing_usage": false
    }
}

Anura Reporting API - Raw Data Endpoints - Report

The Raw Data: Report endpoint will allow you to retrieve detailed, report specific information applicable to the supplied POST parameters.

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

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
raw string The Raw Data report ID being requested.

Example Response

{
    "id": "kuDZdF6v",
    "type": "Response",
    "name": "Anura+Raw+Response+Report+20220924",
    "start": 20220918,
    "end": 20220924,
    "instance_id": 1234567890,
    "instance_name": "yourInstanceName",
    "columns": {
        "standard": [
            "source",
            "campaign",
            "response_id",
            "result",
            "remote_address",
            "network",
            "country",
            "region",
            "city",
            "user_agent",
            "browser_name",
            "browser_version",
            "os_name",
            "os_version",
            "device_type"
        ],
        "additional": null
    },
    "filters": null,
    "requested": "2022-09-24 13:22:31",
    "file_name": "anura-response-yourInstanceName-20220918-20220924-1664025751-f84312.zip",
    "file_size": 208472,
    "rows": 5721,
    "created": "2022-09-24 13:31:46",
    "failed": null,
    "timed_out": null,
    "cancelled": null,
    "status": "Ready",
    "processing_minutes": 10,
    "expires": "2022-10-25 00:00:00"
}

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 60 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.

Limitations

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

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

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,
    "name": "My%20First%20Raw%20Data%20Report",
    "standard": [
        "source",
        "campaign",
        "response_id",
        "result",
        "remote_address",
        "network",
        "country",
        "region",
        "city",
        "user_agent",
        "browser_name",
        "browser_version",
        "os_name",
        "os_version",
        "device_type"
    ],
    "additional": [
        1,
        3,
        5
    ],
    "filters": [
        {
            "column": "source",
            "operator": "contains",
            "value": "hello"
        },
        {
            "column": "campaign",
            "operator": "contains",
            "value": "world"
        }
    ]
}

Example Response

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

Anura Reporting API - Raw Data Endpoints - Cancel

The Raw Data: Cancel endpoint will allow you to cancel "In Progress" report requests applicable to the supplied POST parameters.

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

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
raw string The Raw Data report ID to cancel.

Example Response

{
    "success": true,
    "message": "Your+raw+data+report+request+has+been+cancelled",
    "feedback": {
        "pass": {},
        "fail": {}
    }
}

Anura Reporting API - Raw Data Endpoints - Download

The Raw Data: Download endpoint returns a temporary URL that will allow you to download a self-generated report applicable to the supplied POST parameters.

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

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
raw string The Raw Data report ID to download.

Example Response

{
    "url": "https%3A%2F%2Fanura-reports.s3.amazonaws.com%2Fraw%2F1234567890%2Fresponse%2Fanura-response-yourInstanceName-20220918-20220924-1664025751-f84312.zip"
}

Anura Reporting API - Raw Data Endpoints - Remove

The Raw Data: Remove endpoint will allow you to remove self-generated reports applicable to the supplied POST parameters.

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

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
raw string The Raw Data report ID to remove. An array of report ID strings may also be submitted.

Example Response

{
    "success": true,
    "message": "%22Anura+Raw+Direct+Report+20220924%22+has+been+removed",
    "feedback": {
        "pass": {},
        "fail": {}
    }
}