GET Devices/Uninstalled

Contents

Parameters
Examples
Result Format

200 OK
404 Expired Cursor
429 Too Many Requests
- Usage

Returns a paginated list of uninstalled devices

Endpoint URL: https://api.carnivalmobile.com/v6/devices/uninstalled

Note: There is a 60-day retention period for uninstalled device data.

Parameters

Name	Type	Required	Definition
cursor	string	No	used to retrieve the next batch of devices
from	yyyy-mm-dd	No	optional: retrieve only devices uninstalled from this date/time (accepts an ISO-8601 date or time)
to	yyyy-mm-dd	No	optional: retrieve only devices uninstalled until this date/time (accepts an ISO-8601 date or time)

Examples

# Initial request (first page)
curl -X GET -u :$API_KEY -H "Accept: application/json" https://api.carnivalmobile.com/v6/devices/uninstalled

# Second request (second page)
curl -X GET -u :$API_KEY -H "Accept: application/json" https://api.carnivalmobile.com/v6/devices/uninstalled?cursor=c2Nhbjs1OzMwNTp1MllsUzNyOFFyS19RMkFNLWdVekxnOxfaGl0czo5Ow==

Result Format

200 OK

{
  "meta": {
    "cursor": "c2Nhbjs1OzMwNTp1MllsUzNyOFFyS19RMkFNLWdVekxnOxfaGl0czo5Ow==",
    "total": 15000
  },
  "devices": [
    {
      "id": "5a4f622557ef69***8d54832",
      "user_id": "johnsmith42",
      "email": "johnsmith@example.com",
      "push_enabled": true,
      "platform": "iOS",
      "last_opened": "2016-11-23T20:31:03.000Z",
      "installed_at":"2016-02-14T23:05:36.698Z",
      "user_attributes": {
        "age": {
          "type": "integer",
          "value": 30
        },
        "height": {
          "type": "float",
          "value": 1.75
        },
        "birthdate": {
          "type": "date",
          "value": "1985-05-01T00:00:00Z"
        },
        "vip": {
          "type": "boolean",
          "value": true
        },
        "favorite_color": {
          "type": "string",
          "value": "blue"
        }
      },
      "user_events": {
        "purchase_unlocked": {
          "count": 10,
          "first_happened_at": "2016-05-23T04:12:34.173Z",
          "last_happened_at": "2016-05-24T04:12:34.173Z"
        }
      },
      "location": {
        "gps": {
          "lat": "-41.12345",
          "lng": "174.12345"
        },
        "geoip": {
          "lat": "-41.0",
          "lng": "174.0",
          "city": "Wellington",
          "country": "New Zealand"
        }
      },
      "unregistered_at": "2016-05-24T04:12:34.173Z"
    },...
  ]
}

404 Expired Cursor

# Cursor expired or not found

429 Too Many Requests

# Too many cursor requests

Usage

In every response you'll receive a specific cursor. It should be used to retrieve the next batch of devices.
There's no guarantee on how many devices will be returned per request.
You need to request against this URL until you receive no devices inside the devices array (check for an empty devices array to stop).
A timeout of 2 mins is allowed between requests, if you wait more than this the cursor will expire and you'll have to start again.
The maximum number of open cursors simultaneously is 5.
If both the cursor and date parameter are used the date parameter will be ignored, and only the cursor parameter is used.