{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/audiences/:audience_id/devices","auth":"required","settings":"","examples":{"codes":[{"code":"# Initial request (first page)\ncurl -X GET -u :API_KEY https://api.carnivalmobile.com/v5/audiences/:audience_id/devices\n\n# Second request (second page)\ncurl -X GET -u :API_KEY https://api.carnivalmobile.com/v5/audiences/:audience_id/devices?cursor=c2Nhbjs1OzMwNTp1MllsUzNyOFFyS19RMkFNLWdVekxnOxfaGl0czo5Ow==","language":"curl"}]},"method":"get","params":[{"name":"audience_id","type":"string","default":"","desc":"audience identifier","required":false,"in":"path","ref":"","_id":"57c4b69f6a36a80e002b668a"}],"results":{"codes":[{"status":200,"language":"json","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      \"push_token\": \"d35c15ee345d07f42016738323aa4818e4deacd6****f54dea932a677\",\n      \"platform\": \"iOS\",\n      \"installed_at\":\"2016-02-14T23:05:36.698Z\",\n      \"last_opened\": \"2016-11-23T20:31:03.000Z\",\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    },...\n  ]\n}","name":""},{"name":"Expired Cursor","status":404,"language":"json","code":"# Cursor expired or not found"}]},"apiSetting":null},"next":{"description":"","pages":[]},"title":"Audiences / Devices","type":"endpoint","slug":"audiences-devices","excerpt":"Returns a paginated list of devices belonging to an audience","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`.","updates":[],"order":12,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b1f2cbdfd653400031d8d86","createdAt":"2016-08-29T22:05:33.052Z","parentDoc":null,"__v":5,"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"},"githubsync":"","project":"55e67aaa9cc7c62b00c4a1ea","user":"57c4af04817b390e006f5b26","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"}}

getAudiences / Devices

Returns a paginated list of devices belonging to an audience

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

audience_id:
string
audience identifier

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