{"__v":1,"_id":"55a590680f354f0d00fd033d","category":{"__v":3,"_id":"55afb29b902fd51700f5f8c5","pages":["55b5e0e0c2e909190073eafe","55b5eba1f8105a2f00c34d50","55b5fbc96127b12500364284"],"project":"559a61d2dbcfd20d00710b39","version":"559a61d2dbcfd20d00710b3c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-07-22T15:11:23.686Z","from_sync":false,"order":12,"slug":"segments","title":"Segments"},"parentDoc":null,"project":"559a61d2dbcfd20d00710b39","user":"55a575ebaaf9cf1900114d73","version":{"__v":23,"_id":"559a61d2dbcfd20d00710b3c","project":"559a61d2dbcfd20d00710b39","createdAt":"2015-07-06T11:09:06.510Z","releaseDate":"2015-07-06T11:09:06.510Z","categories":["559a61d3dbcfd20d00710b3d","55a589ddaaf9cf1900114dd0","55a589e30f354f0d00fd0312","55a589ea80c8a30d00b323cc","55a589f6aaf9cf1900114dd1","55a58d4e80c8a30d00b323e6","55a8e7a227a17d21005251a2","55a93098cf45e1390093f351","55afb085f202b12100cd9e83","55afb22e902fd51700f5f8bf","55afb260902fd51700f5f8c2","55afb28ec8a85321007a5462","55afb294f202b12100cd9e95","55afb29b902fd51700f5f8c5","55afb2a1c8a85321007a5463","55afb2a7902fd51700f5f8c7","55afb2ad902fd51700f5f8c8","55afb2b5902fd51700f5f8ca","55b74b2131bccb190081bedc","55bb441b54f9640d006e6cf2","565711085cb2420d00d70071","5681681330018c0d006bf7ff","588f38b5923d610f00c72dad"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Version 1.0","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-14T22:42:48.350Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"The Segment Object\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"createdAt\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Obligatory?\",\n    \"h-3\": \"Description\",\n    \"0-1\": \"long\",\n    \"0-2\": \"Autogenerated\",\n    \"0-3\": \"Creation date (timestamp UTC).\",\n    \"1-0\": \"segmentId\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Autogenerated\",\n    \"1-3\": \"Segment identifier.\",\n    \"2-0\": \"config.name\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Name of the segment.\",\n    \"3-0\": \"config.description\",\n    \"3-1\": \"string\",\n    \"3-2\": \"No\",\n    \"3-3\": \"Description of the segment.\",\n    \"4-0\": \"config.type\",\n    \"4-1\": \"string\",\n    \"4-2\": \"No\",\n    \"4-3\": \"Criteria type.\",\n    \"5-0\": \"config.query\",\n    \"5-1\": \"string\",\n    \"5-2\": \"No\",\n    \"5-3\": \"Criteria query.\",\n    \"6-0\": \"appId\",\n    \"6-1\": \"string\",\n    \"6-2\": \"Autogenerated\",\n    \"6-3\": \"Application key\",\n    \"7-0\": \"updatedAt\",\n    \"7-1\": \"long\",\n    \"7-2\": \"Autogenerated\",\n    \"7-3\": \"Last updated date (timestamp UTC).\"\n  },\n  \"cols\": 4,\n  \"rows\": 8\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sample Segment Object\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"createdAt\\\": 1426026747900,\\n    \\\"segmentId\\\": \\\"dBITKJu7dZDzUf2qOTyZaQ\\\",\\n    \\\"config\\\": {\\n      \\\"name\\\": \\\"Young Female\\\",\\n      \\\"description\\\": \\\"Female users aged 18-35\\\",\\n      \\\"type\\\": \\\"criteria\\\",\\n      \\\"query\\\": \\\"{\\\\\\\"$all\\\\\\\":[{\\\\\\\"tags\\\\\\\":{\\\\\\\"contains\\\\\\\":\\\\\\\"gender:female\\\\\\\"}},{\\\\\\\"tags\\\\\\\":{\\\\\\\"contains\\\\\\\":\\\\\\\"age:18-35\\\\\\\"}}]}\\\",\\n      \\\"labels\\\": null\\n    },\\n    \\\"appId\\\": \\\"vPrwoGAJfXTvJQheeZoMbg\\\",\\n    \\\"updatedAt\\\": 1426026766523\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"A segment is a subset of mobile app audience that is selected by combining criteria that meet a specific objective.","slug":"segments","type":"basic","title":"Segments"}

Segments

A segment is a subset of mobile app audience that is selected by combining criteria that meet a specific objective.

[block:api-header] { "type": "basic", "title": "The Segment Object" } [/block] [block:parameters] { "data": { "0-0": "createdAt", "h-0": "Name", "h-1": "Type", "h-2": "Obligatory?", "h-3": "Description", "0-1": "long", "0-2": "Autogenerated", "0-3": "Creation date (timestamp UTC).", "1-0": "segmentId", "1-1": "string", "1-2": "Autogenerated", "1-3": "Segment identifier.", "2-0": "config.name", "2-1": "string", "2-2": "Yes", "2-3": "Name of the segment.", "3-0": "config.description", "3-1": "string", "3-2": "No", "3-3": "Description of the segment.", "4-0": "config.type", "4-1": "string", "4-2": "No", "4-3": "Criteria type.", "5-0": "config.query", "5-1": "string", "5-2": "No", "5-3": "Criteria query.", "6-0": "appId", "6-1": "string", "6-2": "Autogenerated", "6-3": "Application key", "7-0": "updatedAt", "7-1": "long", "7-2": "Autogenerated", "7-3": "Last updated date (timestamp UTC)." }, "cols": 4, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Sample Segment Object" } [/block] [block:code] { "codes": [ { "code": "{\n \"createdAt\": 1426026747900,\n \"segmentId\": \"dBITKJu7dZDzUf2qOTyZaQ\",\n \"config\": {\n \"name\": \"Young Female\",\n \"description\": \"Female users aged 18-35\",\n \"type\": \"criteria\",\n \"query\": \"{\\\"$all\\\":[{\\\"tags\\\":{\\\"contains\\\":\\\"gender:female\\\"}},{\\\"tags\\\":{\\\"contains\\\":\\\"age:18-35\\\"}}]}\",\n \"labels\": null\n },\n \"appId\": \"vPrwoGAJfXTvJQheeZoMbg\",\n \"updatedAt\": 1426026766523\n }", "language": "json" } ] } [/block]