Anura Docs

Anura Reporting API

The Anura Reporting API is the most advanced method to access report data from Anura Script and Anura Direct outside of our dashboard. With the Anura Reporting API, you can:

Anura Reporting API - Usage

The Anura Reporting API allows you to access Anura reports data from within your own applications. To get started, you will need to create a reporting API token.

Anura Reporting API - Usage - API Tokens

You can create and manage Reporting API tokens by logging into the Anura Dashboard and going to the "Reporting API" token management interface, located within the "Account" section of the navigation menu, or by visiting https://dashboard.anura.io/v1/account/reporting-api.

Create Reporting API Token Form Fields

Field Description Note
Token Name A unique identifying name for the Reporting API token. Required.
Limit Instance Limits the Reporting API to return data for the selected instance(s) only. Data will be returned for all instances associated with your Anura user account when no specification is made.
Limit IP Address Limits the Reporting API to return data for the specified IP address(es) only. Both IPv4 and IPv6 addresses are supported. Private and reserved IP addresses are not allowed.
Token Expires Sets the token to expire on a specified date. Reporting API tokens expire at 12:00 AM Coordinated Universal Time (UTC) on their specified date and will be removed from our database after 30 days. Reporting API tokens that do not have an expiration will otherwise never expire.

Managing Reporting API Tokens

Anura Reporting API - Usage - Performing Requests

Requests to the Anura Reporting API are made over secure connections using the HTTP POST method.

Things to Remember...

Limitations

Date specific API requests are limited to a 7-day rolling time frame with the exception of "Overview" endpoints, which have a 31-day rolling time frame. If your request falls outside of the time frame limit, a HTTP status code of "400 - Bad Request" will be returned. See Reporting API: Handling Responses for more details.

Anura Reporting API - Usage - Handling Responses

Responses from the Anura Reporting API are JSON encoded and typically returned within milliseconds. However, in cases where vast amounts of unique data exist, responses may take several seconds or minutes. Please be sure to adjust any timeouts to wait until the response has been returned.

There are 5 distinct HTTP status response codes that may be encountered when performing requests. The following table provides HTTP status codes with a brief description of their meaning:

Status Code Description
200 - OK The request was successful and a response was returned.
400 - Bad Request There was a problem with your request parameters. Please be sure you have passed a complete and valid token string and that your request falls within the allowed rolling time frame.
401 - Unauthorized Your token is not authorized to access the requested resource.
403 - Forbidden Your token does not have permission to access the requested resource.
404 - Not Found The resource you are looking for was not found. Please check the endpoint address and try again.

Things to Remember...

Anura Reporting API - Interface Endpoints

The following Interface data endpoints are available in the current version of the Anura Reporting API.

Anura Reporting API - Interface Endpoints - Instances

The instances endpoint will allow you to retrieve, or search, instances associated with your Reporting API token.

Method URL
POST https://api.anura.io/v1/interface/instances

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
name string The name value to which results will be limited. Results are returned based on a broad match of the declared value.
all boolean Set false to exclude the "All Instances" result object. True 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.

Example Response

{
    "instances": [
        {
            "id": "All+Instances",
            "name": "All+Instances"
        },
        {
            "id": 1234567890,
            "name": "yourInstanceName"
        }
    ],
    "query": {
        "name": false,
        "all": true,
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Interface Endpoints - Sources

The sources endpoint will allow you to retrieve, or search, sources applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/interface/sources

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
instance string The ID of the instance to which results will be limited.
source string The source value to which results will be limited. Results are returned based on a broad match of the declared value.
all boolean Set false to exclude the "All Sources" result. True 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.

Example Response

{
    "sources": [
        "All+Sources",
        "yourSourceTrackingId"
    ],
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "all": true,
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Interface Endpoints - Campaigns

The campaigns endpoint will allow you to retrieve, or search, campaigns applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/interface/campaigns

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited. Results are returned based on a broad match of the declared value.
all boolean Set false to exclude the "All Campaigns" result. True 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.

Example Response

{
    "campaigns": [
        "All+Campaigns",
        "yourCampaignTrackingId"
    ],
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "all": true,
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints

The following Script data reporting endpoints are available in the current version of the Anura Reporting API.

Anura Reporting API - Script Endpoints - Overview

The overview endpoint will allow you to retrieve total counts of data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/overview

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.

Example Response

{
    "total": {
        "drops": 2,
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "chart": false
    }
}

Anura Reporting API - Script Endpoints - Sessions

The sessions endpoint will allow you to retrieve a table of session specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/sessions

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "drops": 2,
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Instance",
            "Requests",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            "%7B%22id%22%3A%22All+Instances%22%2C%22name%22%3A%22All+Instances%22%7D",
            25,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "%7B%22id%22%3A1234567890%2C%22name%22%3A%22yourInstanceName%22%7D",
                25,
                23,
                10,
                5,
                8,
                2,
                1
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 1,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Browsers

The browsers endpoint will allow you to retrieve a table of web browser specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/browsers

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
browser string The browser to which results will be limited.
browser_version string The browser version to which results will be limited. Applied only when the "browser" parameter is set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "drops": 2,
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Browser",
            "Requests",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            25,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "Chrome",
                18,
                17,
                7,
                4,
                6,
                2,
                1
            ],
            [
                "Firefox",
                7,
                6,
                3,
                1,
                2,
                0,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "browser": false,
        "browser_version": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Operating Systems

The operating systems endpoint will allow you to retrieve a table of operating system specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/operating-systems

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end string The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
os string The operating system to which results will be limited.
os_version string The operating system version to which results will be limited. Applied only when the "os" parameter is set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "drops": 2,
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "OS",
            "Requests",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            25,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "Windows",
                23,
                21,
                8,
                5,
                8,
                0,
                1
            ],
            [
                "Android",
                2,
                2,
                2,
                0,
                0,
                2,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "os": false,
        "os_version": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Devices

The devices endpoint will allow you to retrieve a table of device specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/devices

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
manufacturer string The manufacturer to which results will be limited.
model string The model to which results will be limited. Applied only when the "manufacturer" parameter is set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "drops": 2,
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Manufacturer",
            "Requests",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            25,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "%28non-identifiable%29",
                23,
                21,
                8,
                5,
                8,
                0,
                1
            ],
            [
                "Samsung",
                2,
                2,
                2,
                0,
                0,
                2,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "manufacturer": false,
        "model": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Device Types

The device types endpoint will allow you to retrieve a table of device type specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/device-types

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
type string The type to which results will be limited.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "drops": 2,
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Type",
            "Requests",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            25,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "desktop",
                23,
                21,
                8,
                5,
                8,
                0,
                1
            ],
            [
                "mobile:smart",
                2,
                2,
                2,
                0,
                0,
                2,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "type": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Geography

The geography endpoint will allow you to retrieve a table of geographical specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/geography

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
country string The country to which results will be limited.
region string The region to which results will be limited. Applied only when the "country" parameter is set.
city string The city to which results will be limited. Applied only when the "country" and "region" parameters are set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "drops": 2,
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Country",
            "Requests",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            25,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "United+States",
                18,
                17,
                5,
                4,
                8,
                2,
                0
            ],
            [
                "Canada",
                7,
                6,
                5,
                1,
                0,
                0,
                1
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "country": false,
        "region": false,
        "city": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Languages

The languages endpoint will allow you to retrieve a table of language specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/languages

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
language string The language to which results will be limited.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Language",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "en-us",
                17,
                5,
                4,
                8,
                2,
                0
            ],
            [
                "en-ca",
                6,
                5,
                1,
                0,
                0,
                1
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "language": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Networks

The networks endpoint will allow you to retrieve a table of network specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/networks

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
network string The network to which results will be limited.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "drops": 2,
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Network",
            "Requests",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            25,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "Comcast+Cable+Communications%2C+LLC",
                18,
                17,
                5,
                4,
                8,
                2,
                0
            ],
            [
                "Rogers+Communications+Canada+Inc.",
                7,
                6,
                5,
                1,
                0,
                0,
                1
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "network": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Connections

The connections endpoint will allow you to retrieve a table of connection specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/connections

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
connection string The connection to which results will be limited.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "drops": 2,
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Connection",
            "Requests",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            25,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "Cable%2FDSL",
                23,
                21,
                8,
                5,
                8,
                0,
                1
            ],
            [
                "Cellular",
                2,
                2,
                2,
                0,
                0,
                2,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "connection": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Pages

The pages endpoint will allow you to retrieve a table of page specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/pages

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
host string The host to which results will be limited.
path string The path to which results will be limited. Applied only when the "host" parameter is set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Host",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "www.anura.io",
                13,
                7,
                2,
                4,
                1,
                1
            ],
            [
                "docs.anura.io",
                10,
                3,
                3,
                4,
                1,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "host": false,
        "path": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Script Endpoints - Referrers

The referrers endpoint will allow you to retrieve a table of referrer specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/script/referrers

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
host string The host to which results will be limited.
path string The path to which results will be limited. Applied only when the "host" parameter is set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "good": 10,
        "warning": 5,
        "bad": 8,
        "mobile": 2,
        "adblocker": 1
    },
    "table": {
        "headers": [
            "Host",
            "Responses",
            "Good",
            "Warning",
            "Bad",
            "Mobile",
            "Ad+Blocker"
        ],
        "all": [
            false,
            23,
            10,
            5,
            8,
            2,
            1
        ],
        "rows": [
            [
                "%28direct%29",
                14,
                2,
                3,
                9,
                1,
                1
            ],
            [
                "www.google.com",
                9,
                8,
                1,
                0,
                1,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "host": false,
        "path": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Direct Endpoints

The following Direct data reporting endpoints are available in the current version of the Anura Reporting API.

Anura Reporting API - Direct Endpoints - Overview

The overview endpoint will allow you to retrieve total counts of data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/direct/overview

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.

Example Response

{
    "total": {
        "nonsuspect": 17,
        "suspect": 8,
        "mobile": 2
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "chart": false
    }
}

Anura Reporting API - Direct Endpoints - Sessions

The sessions endpoint will allow you to retrieve a table of session specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/direct/sessions

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "nonsuspect": 17,
        "suspect": 8,
        "mobile": 2
    },
    "table": {
        "headers": [
            "Instance",
            "Requests",
            "Non-Suspect",
            "Suspect",
            "Mobile"
        ],
        "all": [
            "%7B%22id%22%3A%22All+Instances%22%2C%22name%22%3A%22All+Instances%22%7D",
            25,
            17,
            8,
            2
        ],
        "rows": [
            [
                "%7B%22id%22%3A1234567890%2C%22name%22%3A%22yourInstanceName%22%7D",
                25,
                17,
                8,
                2
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 1,
        "pages": 1
    }
}

Anura Reporting API - Direct Endpoints - Browsers

The browsers endpoint will allow you to retrieve a table of web browser specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/direct/browsers

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end string The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
browser string The browser to which results will be limited.
browser_version string The browser version to which results will be limited. Applied only when the "browser" parameter is set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "nonsuspect": 17,
        "suspect": 8,
        "mobile": 2
    },
    "table": {
        "headers": [
            "Browser",
            "Requests",
            "Non-Suspect",
            "Suspect",
            "Mobile"
        ],
        "all": [
            false,
            25,
            17,
            8,
            2
        ],
        "rows": [
            [
                "Chrome",
                18,
                14,
                4,
                2
            ],
            [
                "Firefox",
                7,
                3,
                4,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "browser": false,
        "browser_version": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Direct Endpoints - Operating Systems

The operating systems endpoint will allow you to retrieve a table of operating system specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/direct/operating-systems

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
os string The operating system to which results will be limited.
os_version string The operating system version to which results will be limited. Applied only when the "os" parameter is set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "nonsuspect": 17,
        "suspect": 8,
        "mobile": 2
    },
    "table": {
        "headers": [
            "OS",
            "Requests",
            "Non-Suspect",
            "Suspect",
            "Mobile"
        ],
        "all": [
            false,
            25,
            17,
            8,
            2
        ],
        "rows": [
            [
                "Windows",
                23,
                15,
                8,
                0
            ],
            [
                "Android",
                2,
                2,
                0,
                2
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "os": false,
        "os_version": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Direct Endpoints - Devices

The devices endpoint will allow you to retrieve a table of device specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/direct/devices

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
manufacturer string The manufacturer to which results will be limited.
model string The model to which results will be limited. Applied only when the "manufacturer" parameter is set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "nonsuspect": 17,
        "suspect": 8,
        "mobile": 2
    },
    "table": {
        "headers": [
            "Manufacturer",
            "Requests",
            "Non-Suspect",
            "Suspect",
            "Mobile"
        ],
        "all": [
            false,
            25,
            17,
            8,
            2
        ],
        "rows": [
            [
                "%28non-identifiable%29",
                23,
                15,
                8,
                0
            ],
            [
                "Samsung",
                2,
                2,
                0,
                2
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "manufacturer": false,
        "model": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Direct Endpoints - Device Types

The device types endpoint will allow you to retrieve a table of device type specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/direct/device-types

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
type string The type to which results will be limited.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "nonsuspect": 17,
        "suspect": 8,
        "mobile": 2
    },
    "table": {
        "headers": [
            "Type",
            "Requests",
            "Non-Suspect",
            "Suspect",
            "Mobile"
        ],
        "all": [
            false,
            25,
            17,
            8,
            2
        ],
        "rows": [
            [
                "desktop",
                23,
                15,
                8,
                0
            ],
            [
                "mobile:smart",
                2,
                2,
                0,
                2
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "type": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Direct Endpoints - Geography

The geography endpoint will allow you to retrieve a table of geographical specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/direct/geography

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
country string The country to which results will be limited.
region string The region to which results will be limited. Applied only when the "country" parameter is set.
city string The city to which results will be limited. Applied only when the "country" and "region" parameters are set.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "nonsuspect": 17,
        "suspect": 8,
        "mobile": 2
    },
    "table": {
        "headers": [
            "Country",
            "Requests",
            "Non-Suspect",
            "Suspect",
            "Mobile"
        ],
        "all": [
            false,
            25,
            17,
            8,
            2
        ],
        "rows": [
            [
                "United+States",
                16,
                11,
                5,
                2
            ],
            [
                "Canada",
                9,
                6,
                3,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "country": false,
        "region": false,
        "city": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Direct Endpoints - Networks

The networks endpoint will allow you to retrieve a table of network specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/direct/networks

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
network string The network to which results will be limited.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "nonsuspect": 17,
        "suspect": 8,
        "mobile": 2
    },
    "table": {
        "headers": [
            "Network",
            "Requests",
            "Non-Suspect",
            "Suspect",
            "Mobile"
        ],
        "all": [
            false,
            25,
            17,
            8,
            2
        ],
        "rows": [
            [
                "Comcast+Cable+Communications%2C+LLC",
                16,
                11,
                5,
                2
            ],
            [
                "Rogers+Communications+Canada+Inc.",
                9,
                6,
                3,
                0
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "network": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}

Anura Reporting API - Direct Endpoints - Connections

The connections endpoint will allow you to retrieve a table of connection specific data applicable to the supplied POST parameters.

Method URL
POST https://api.anura.io/v1/direct/connections

Parameters

Required Type Description Note
token string The token string you have been issued to connect to the Anura Reporting API.
start integer The starting date from which results will be returned. Date format: YYYYMMDD
end integer The ending date to which results will be returned. Date format: YYYYMMDD
Optional Type Description Note
connection string The connection to which results will be limited.
instance string The ID of the instance to which results will be limited.
source string The source to which results will be limited.
campaign string The campaign value to which results will be limited.
chart boolean Set true to include a chartable daily breakdown. False by default.
rates boolean Set true to include percentage rates. False by default.
rules boolean Set true to include broken rule sets. False by default.
search string The first column value to which results will be limited. Results are returned based on a broad match of the declared value.
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. "1: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.

Example Response

{
    "total": {
        "nonsuspect": 17,
        "suspect": 8,
        "mobile": 2
    },
    "table": {
        "headers": [
            "Connection",
            "Requests",
            "Non-Suspect",
            "Suspect",
            "Mobile"
        ],
        "all": [
            false,
            25,
            17,
            8,
            2
        ],
        "rows": [
            [
                "Cable%2FDSL",
                23,
                15,
                8,
                0
            ],
            [
                "Cellular",
                2,
                2,
                0,
                2
            ]
        ]
    },
    "query": {
        "start": 20180101,
        "end": 20180101,
        "instance": false,
        "source": false,
        "campaign": false,
        "connection": false,
        "chart": false,
        "rates": false,
        "rules": false,
        "search": false,
        "sort": "1:desc",
        "page": 1,
        "limit": 20,
        "results": 2,
        "pages": 1
    }
}