GET Stats / 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.

Endpoint URL: https://api.carnivalmobile.com/v6/stats/opens


Parameters

Name Type Required Definition
from datetime Beginning date for range
to datetime End date for range

Examples

Copy
# Default parameters (Last Month)
curl -X GET -u :$API_KEY -H 'Accept: application/json' https://api.carnivalmobile.com/v6/stats/opens

# With Parameters for To and From
curl -X GET -u :$API_KEY -H 'Accept: application/json' https://api.carnivalmobile.com/v6/stats/opens?from=2015-07-25&to=2015-07-28

Result Format

200 OK

Copy
[
  {
    "date": "2015-07-25T00:00:00.000Z",
    "count": 23543
  },
  {
    "date": "2015-07-26T00:00:00.000Z",
    "count": 66435
  },
  {
    "date": "2015-07-27T00:00:00.000Z",
    "count": 23542
  },
  {
    "date": "2015-07-28T00:00:00.000Z",
    "count": 35457
  }
]

401 Unauthorized

Copy
{
  "error":"unauthorized"}

403 Forbidden

Copy
{
  "error":"your api client does not have the correct roles"}

Date Format

This API endpoint uses the ISO 8601 DateTime format. 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 marks.