GET Stats / Active Users

Contents

Parameters
Examples
Result Format

200 OK
401 Unauthorized
403 Forbidden
- Date Format

Returns a list of unique users by day in the context of a month window Endpoint URL: https://api.carnivalmobile.com/v6/stats/active_users

Parameters

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

Examples

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

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

Result Format

200 OK

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

401 Unauthorized

{
  "error":"unauthorized"
}

403 Forbidden

{
  "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 mark.