{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/stats/sessions","auth":"required","examples":{"codes":[{"name":"","code":"# Default parameters (Last Month)\ncurl -X GET -i -u :$API_KEY -H 'Accept: application/json' https://api.carnivalmobile.com/v6/stats/sessions\n\n# With Parameters for To and From\ncurl -XGET -i -u :$API_KEY -H 'Accept: application/json' https://api.carnivalmobile.com/v6/stats/sessions?from=2018-07-25&to=2018-07-28","language":"curl"}]},"method":"get","params":[{"name":"from","type":"datetime","default":"One month ago","desc":"Beginning date for range","required":false,"in":"query","ref":"","_id":"55ed11410d968e2100de834f"},{"name":"to","type":"datetime","default":"now","desc":"End date for range","required":false,"in":"query","ref":"","_id":"55ed11410d968e2100de834e"}],"results":{"codes":[{"code":"[\n  {\n    \"date\": \"2015-07-25T00:00:00.000Z\",\n    \"count\": 23543\n  },\n  {\n    \"date\": \"2015-07-26T00:00:00.000Z\",\n    \"count\": 66435\n  },\n  {\n    \"date\": \"2015-07-27T00:00:00.000Z\",\n    \"count\": 23542\n  },\n  {\n    \"date\": \"2015-07-28T00:00:00.000Z\",\n    \"count\": 35457\n  }\n]","language":"json","status":200,"name":""},{"name":"","code":"{\n  \"error\":\"unauthorized\"\n}","language":"json","status":401},{"code":"{\n  \"error\":\"your api client does not have the correct roles\"\n}","language":"json","status":403}]},"settings":"","apiSetting":null},"next":{"description":"","pages":[]},"title":"Stats / Time in app","type":"endpoint","slug":"time-in-app","excerpt":"Time in app sessions are returned as a feed of DateTime objects with counts next to them. These timestamps represent the beginning of an hour period, and the count is the number of sessions that happened in that hour.","body":"## Date Format\n\nThis API endpoint uses the [ISO 8601 DateTime format](https://en.wikipedia.org/wiki/ISO_8601). \n\nExamples:\n\n * `2015-07-25` (Just date)\n * `2015-07-25T00:00:00.000+00:00` (Date, Time, Offset)\n\nNote: When running the curl command with parameters, you should wrap the URL in double quotation mark.","updates":[],"order":19,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e6156bf5e4a51006dcd813e","parentDoc":null,"__v":8,"createdAt":"2015-09-07T04:23:29.048Z","githubsync":"","version":{"version":"1.5","version_clean":"1.5.0","codename":"ST Rebrand","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e6156bf5e4a51006dcd8120","5e6156bf5e4a51006dcd8121","5e6156bf5e4a51006dcd8122","5e6156bf5e4a51006dcd8123","5e6156bf5e4a51006dcd8124","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","5e6156bf5e4a51006dcd8125","5e6156bf5e4a51006dcd8126","5af0fe494ca2730003cbc98a","5af0fe55ec80af0003804ca2","5e69868cbd5dcb006b35867b","5e6986ca2c6652006791b6e8"],"_id":"5e6156bf5e4a51006dcd818c","project":"55e67aaa9cc7c62b00c4a1ea","__v":2,"forked_from":"5b720760c44b7600034b7a08","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z"},"editedParams":true,"project":"55e67aaa9cc7c62b00c4a1ea","user":"55d2bd8e2463351700f67dd7","category":{"sync":{"isSync":false,"url":""},"pages":["5e6156bf5e4a51006dcd8138","55ed079b0d968e2100de8339","5e6156bf5e4a51006dcd8139","55ed0bb078319821005005cf","5e6156bf5e4a51006dcd813a","5e6156bf5e4a51006dcd813b","5e6156bf5e4a51006dcd813c","5e6156bf5e4a51006dcd813d","5e6156bf5e4a51006dcd813e","5e6156bf5e4a51006dcd813f","5e6156bf5e4a51006dcd8140","5e6156bf5e4a51006dcd8141","5e6156bf5e4a51006dcd8142","5e6156bf5e4a51006dcd8143","5e6156bf5e4a51006dcd8144","5e6156bf5e4a51006dcd8145","5b720760c44b7600034b79ce","5e6156bf5e4a51006dcd814d","5e6156bf5e4a51006dcd814e","5e6156bf5e4a51006dcd8156"],"title":"REST API","slug":"rest-api","order":5,"from_sync":false,"reference":true,"_id":"5e6156bf5e4a51006dcd8122","__v":20,"createdAt":"2015-09-02T04:30:21.948Z","project":"55e67aaa9cc7c62b00c4a1ea","version":"5e6156bf5e4a51006dcd818c"},"editedParams2":true}

getStats / Time in app

Time in app sessions are returned as a feed of DateTime objects with counts next to them. These timestamps represent the beginning of an hour period, and the count is the number of sessions that happened in that hour.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

from:
datetimeOne month ago
Beginning date for range
to:
datetimenow
End date for range

Examples


Result Format


Documentation

## Date Format This API endpoint uses the [ISO 8601 DateTime format](https://en.wikipedia.org/wiki/ISO_8601). Examples: * `2015-07-25` (Just date) * `2015-07-25T00:00:00.000+00:00` (Date, Time, Offset) Note: When running the curl command with parameters, you should wrap the URL in double quotation mark.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}