{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/stats/opens","auth":"required","settings":"","examples":{"codes":[{"name":"","language":"curl","code":"# Default parameters (Last Month)\ncurl -X GET -u :API_KEY https://api.carnivalmobile.com/v5/stats/opens\n\n# With Parameters for To and From\ncurl -X GET -u :API_KEY https://api.carnivalmobile.com/v5/stats/opens?from=2015-07-25&to=2015-07-28"}]},"method":"get","params":[{"name":"from","type":"datetime","default":"1 month ago","desc":"Beginning date for range","required":false,"in":"query","ref":"","_id":"55ed0df94fba582b0036a18c"},{"name":"to","type":"string","default":"Now","desc":"End date for range","required":false,"in":"query","ref":"","_id":"55ed0df94fba582b0036a18b"}],"results":{"codes":[{"name":"","code":"[\n  {\n    \"date\": \"2015-07-25T00:00:00.000+00:00\",\n    \"count\": 23543\n  },\n  {\n    \"date\": \"2015-07-26T00:00:00.000+00:00\",\n    \"count\": 66435\n  },\n  {\n    \"date\": \"2015-07-27T00:00:00.000+00:00\",\n    \"count\": 23542\n  },\n  {\n    \"date\": \"2015-07-28T00:00:00.000+00:00\",\n    \"count\": 35457\n  }\n]","language":"json","status":200},{"status":401,"name":"","code":"{\n  \"error\":\"unauthorized\"\n}","language":"json"},{"language":"json","status":403,"code":"{\n  \"error\":\"your api client does not have the correct roles\"\n}"}]},"apiSetting":null},"next":{"description":"","pages":[]},"title":"Stats / Opens","type":"endpoint","slug":"opens","excerpt":"Opens 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 opens 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)","updates":[],"order":16,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f2cbdfd653400031d8d5d","version":{"version":"1.3","version_clean":"1.3.0","codename":"rebrand","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5b1f2cbdfd653400031d8d42","5b1f2cbdfd653400031d8d43","5b1f2cbdfd653400031d8d44","5b1f2cbdfd653400031d8d45","5b1f2cbdfd653400031d8d46","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","5b1f2cbdfd653400031d8d47","5b1f2cbdfd653400031d8d48","5af0fe494ca2730003cbc98a","5af0fe55ec80af0003804ca2"],"_id":"5b1f2cbdfd653400031d8d9f","project":"55e67aaa9cc7c62b00c4a1ea","__v":0,"forked_from":"55e67aab9cc7c62b00c4a1ed","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z"},"editedParams":true,"editedParams2":true,"parentDoc":null,"__v":1,"createdAt":"2015-09-07T04:12:45.812Z","githubsync":"","user":"55d2bd8e2463351700f67dd7","category":{"sync":{"isSync":false,"url":""},"pages":["5b1f2cbdfd653400031d8d59","55ed079b0d968e2100de8339","5b1f2cbdfd653400031d8d5a","55ed0bb078319821005005cf","5b1f2cbdfd653400031d8d5b","5b1f2cbdfd653400031d8d5c","5b1f2cbdfd653400031d8d5d","5b1f2cbdfd653400031d8d5e","5b1f2cbdfd653400031d8d5f","5b1f2cbdfd653400031d8d60","5b1f2cbdfd653400031d8d61","5b1f2cbdfd653400031d8d62","5b1f2cbdfd653400031d8d63","5b1f2cbdfd653400031d8d64","5b1f2cbdfd653400031d8d65","5b1f2cbdfd653400031d8d66","5b1f2cbdfd653400031d8d67","5b1f2cbdfd653400031d8d6f","5b1f2cbdfd653400031d8d70","5b1f2cbdfd653400031d8d78"],"title":"REST API","slug":"rest-api","order":5,"from_sync":false,"reference":true,"_id":"5b1f2cbdfd653400031d8d44","__v":20,"createdAt":"2015-09-02T04:30:21.948Z","project":"55e67aaa9cc7c62b00c4a1ea","version":"5b1f2cbdfd653400031d8d9f"},"project":"55e67aaa9cc7c62b00c4a1ea"}

getStats / Opens

Opens 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 opens that happened in that hour.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

from:
datetime1 month ago
Beginning date for range
to:
stringNow
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)

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