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
}
}