Direct Endpoints - Anura Reporting API

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 Direct: 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 Direct: 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.
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. "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 Direct: 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.
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. "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 Direct: 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.
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. "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 Direct: 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.
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. "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 Direct: 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.
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. "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 Direct: 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.
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. "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 Direct: 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.
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. "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 Direct: 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.
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. "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
    }
}