Anura Docs

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