{"_id":"5b720760c44b7600034b79fa","githubsync":"","project":"55e67aaa9cc7c62b00c4a1ea","parentDoc":null,"version":{"_id":"5b720760c44b7600034b7a08","project":"55e67aaa9cc7c62b00c4a1ea","__v":0,"forked_from":"5b1f2cbdfd653400031d8d9f","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z","categories":["5b720760c44b7600034b79a7","5b720760c44b7600034b79a8","5b720760c44b7600034b79a9","5b720760c44b7600034b79aa","5b720760c44b7600034b79ab","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","5b720760c44b7600034b79ac","5b720760c44b7600034b79ad","5af0fe494ca2730003cbc98a","5af0fe55ec80af0003804ca2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"API V6","version_clean":"1.4.0","version":"1.4"},"category":{"_id":"5b720760c44b7600034b79a9","__v":20,"pages":["5b720760c44b7600034b79c0","55ed079b0d968e2100de8339","5b720760c44b7600034b79c1","55ed0bb078319821005005cf","5b720760c44b7600034b79c2","5b720760c44b7600034b79c3","5b720760c44b7600034b79c4","5b720760c44b7600034b79c5","5b720760c44b7600034b79c6","5b720760c44b7600034b79c7","5b720760c44b7600034b79c8","5b720760c44b7600034b79c9","5b720760c44b7600034b79ca","5b720760c44b7600034b79cb","5b720760c44b7600034b79cc","5b720760c44b7600034b79cd","5b720760c44b7600034b79ce","5b720760c44b7600034b79d6","5b720760c44b7600034b79d7","5b720760c44b7600034b79df"],"project":"55e67aaa9cc7c62b00c4a1ea","version":"5b720760c44b7600034b7a08","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-02T04:30:21.948Z","from_sync":false,"order":5,"slug":"rest-api","title":"REST API"},"user":"56e5d6f82d90970e00af1b92","__v":3,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-03T23:17:51.532Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"code":"{\n  \"meta\": {\n    \"cursor\": \"c2Nhbjs1OzMwNTp1MllsUzNyOFFyS19RMkFNLWdVekxnOxfaGl0czo5Ow==\",\n    \"total\": 15000\n  },\n  \"devices\": [\n    {\n      \"id\": \"5a4f622557ef69***8d54832\",\n      \"user_id\": \"johnsmith42\",\n      \"email\": \"johnsmith:::at:::example.com\",\n      \"push_enabled\": true,\n      \"platform\": \"iOS\",\n      \"last_opened\": \"2016-11-23T20:31:03.000Z\",\n      \"installed_at\":\"2016-02-14T23:05:36.698Z\",\n      \"user_attributes\": {\n        \"age\": {\n          \"type\": \"integer\",\n          \"value\": 30\n        },\n        \"height\": {\n          \"type\": \"float\",\n          \"value\": 1.75\n        },\n        \"birthdate\": {\n          \"type\": \"date\",\n          \"value\": \"1985-05-01T00:00:00Z\"\n        },\n        \"vip\": {\n          \"type\": \"boolean\",\n          \"value\": true\n        },\n        \"favorite_color\": {\n          \"type\": \"string\",\n          \"value\": \"blue\"\n        }\n      },\n      \"user_events\": {\n        \"purchase_unlocked\": {\n          \"count\": 10,\n          \"first_happened_at\": \"2016-05-23T04:12:34.173Z\",\n          \"last_happened_at\": \"2016-05-24T04:12:34.173Z\"\n        }\n      },\n      \"location\": {\n        \"gps\": {\n          \"lat\": \"-41.12345\",\n          \"lng\": \"174.12345\"\n        },\n        \"geoip\": {\n          \"lat\": \"-41.0\",\n          \"lng\": \"174.0\",\n          \"city\": \"Wellington\",\n          \"country\": \"New Zealand\"\n        }\n      },\n      \"unregistered_at\": \"2016-05-24T04:12:34.173Z\"\n    },...\n  ]\n}","name":"","status":200,"language":"json"},{"name":"Expired Cursor","status":404,"language":"json","code":"# Cursor expired or not found"}]},"settings":"","examples":{"codes":[{"language":"curl","code":"# Initial request (first page)\ncurl -X GET -u :API_KEY https://api.carnivalmobile.com/v6/devices/uninstalled\n\n# Second request (second page)\ncurl -X GET -u :API_KEY https://api.carnivalmobile.com/v6/devices/uninstalled?cursor=c2Nhbjs1OzMwNTp1MllsUzNyOFFyS19RMkFNLWdVekxnOxfaGl0czo5Ow=="}]},"apiSetting":null,"auth":"required","params":[{"_id":"590a651fab8ea80f00c209d9","ref":"","in":"query","required":false,"desc":"used to retrieve the next batch of devices","default":"","type":"string","name":"cursor"},{"_id":"590a651fab8ea80f00c209d8","ref":"","in":"query","required":false,"desc":"optional: retrieve only devices uninstalled from this date/time (accepts an ISO-8601 date or time)","default":"","type":"yyyy-mm-dd","name":"from"},{"_id":"590a651fab8ea80f00c209d7","ref":"","in":"query","required":false,"desc":"optional: retrieve only devices uninstalled until this date/time (accepts an ISO-8601 date or time)","default":"","type":"yyyy-mm-dd","name":"to"}],"url":"/devices/uninstalled"},"isReference":true,"order":5,"body":"## Usage\n\n- In every response you'll receive a specific cursor. It should be used to retrieve the next batch of devices.\n- There's no guarantee on how many devices will be returned per request.\n- You need to request against this URL until you receive no devices inside the devices array (check for an empty devices array to stop).\n- 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.\n- The maximum number of open cursors simultaneously is `5`.","excerpt":"Returns a paginated list of uninstalled devices","slug":"devices-uninstalled","type":"endpoint","title":"Devices / Uninstalled"}

getDevices / Uninstalled

Returns a paginated list of uninstalled devices

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

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

Examples


Result Format


Documentation

## 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`.

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