{"__v":3,"_id":"55a5901780c8a30d00b323f6","category":{"__v":0,"_id":"55afb294f202b12100cd9e95","pages":[],"project":"559a61d2dbcfd20d00710b39","version":"559a61d2dbcfd20d00710b3c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-07-22T15:11:16.926Z","from_sync":false,"order":8,"slug":"campaigns","title":"Campaigns"},"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:41:27.985Z","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 Campaign Object\"\n}\n[/block]\nAttributes:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Obligatory?\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"createdAt\",\n    \"0-3\": \"Creation date (timestamp UTC).\",\n    \"0-1\": \"long\",\n    \"0-2\": \"Autogenerated\",\n    \"1-0\": \"campaignId\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Autogenerated\",\n    \"1-3\": \"Campaign Identifier\",\n    \"2-0\": \"config.name\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Yes\",\n    \"2-3\": \"Name of the campaign\",\n    \"3-0\": \"config.description\",\n    \"3-1\": \"string\",\n    \"3-2\": \"No\",\n    \"3-3\": \"Description of the campaign\",\n    \"4-0\": \"config.updatedAt\",\n    \"4-1\": \"long\",\n    \"4-2\": \"Autogenerated\",\n    \"4-3\": \"Last modification date (timestamp UTC).\",\n    \"5-0\": \"config.startAt\",\n    \"5-1\": \"long\",\n    \"5-2\": \"Yes\",\n    \"5-3\": \"Campaign start date (timestamp UTC).\",\n    \"6-0\": \"config.endAt\",\n    \"6-1\": \"long\",\n    \"6-2\": \"Yes\",\n    \"6-3\": \"Campaign end date (timestamp UTC).\",\n    \"7-0\": \"config.segmentId\",\n    \"7-1\": \"string\",\n    \"7-2\": \"No\",\n    \"7-3\": \"Id of the target segment.\",\n    \"10-0\": \"status\",\n    \"10-1\": \"string\",\n    \"10-2\": \"Autogenerated\",\n    \"10-3\": \"Current status of the campaign.\",\n    \"11-0\": \"statusAt\",\n    \"11-1\": \"long\",\n    \"11-2\": \"Autogenerated\",\n    \"11-3\": \"Last status update date (timestamp UTC).\",\n    \"12-0\": \"appId\",\n    \"12-1\": \"string\",\n    \"12-2\": \"Yes\",\n    \"12-3\": \"Application key.\",\n    \"13-0\": \"numExperiences\",\n    \"13-1\": \"integer\",\n    \"13-2\": \"Autogenerated\",\n    \"13-3\": \"Number of experiences in this campaign.\",\n    \"8-0\": \"config.displayCap*\",\n    \"8-1\": \"integer\",\n    \"8-2\": \"No\",\n    \"8-3\": \"Maximum number of experiences that will be triggered within the campaign.\",\n    \"9-0\": \"config.displayWaitMs*\",\n    \"9-1\": \"integer\",\n    \"9-2\": \"No\",\n    \"9-3\": \"Minimum delay between experiences triggered within the campaign.\"\n  },\n  \"cols\": 4,\n  \"rows\": 14\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Advanced settings\",\n  \"body\": \"Fields marked with * will not be displayed in the response payload if not set.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Sample Campaign Object\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"createdAt\\\": 1437405339834,\\n  \\\"campaignId\\\": \\\"sZHuQ7enqPHJIHKkYnkxMw\\\",\\n  \\\"config\\\": {\\n    \\\"name\\\": \\\"Test\\\",\\n    \\\"description\\\": \\\"Test Campaign\\\",\\n    \\\"updatedAt\\\": 1437405339834,\\n    \\\"startAt\\\": 1437405300000,\\n    \\\"endAt\\\": 1438703200000,\\n    \\\"segmentId\\\": null\\n  },\\n  \\\"status\\\": \\\"New\\\",\\n  \\\"statusAt\\\": 1437405339834,\\n  \\\"updatedAt\\\": 1437405339834,\\n  \\\"appId\\\": \\\"ojvcFIS3kiAyIzcmvN1SvS\\\",\\n  \\\"numExperiences\\\": 12\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Campaigns represent marketing campaigns within an app that take place in a period of time and usually target a segment of the users.","slug":"campaigns","type":"basic","title":"Campaigns"}

Campaigns

Campaigns represent marketing campaigns within an app that take place in a period of time and usually target a segment of the users.

[block:api-header] { "type": "basic", "title": "The Campaign Object" } [/block] Attributes: [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Obligatory?", "h-3": "Description", "0-0": "createdAt", "0-3": "Creation date (timestamp UTC).", "0-1": "long", "0-2": "Autogenerated", "1-0": "campaignId", "1-1": "string", "1-2": "Autogenerated", "1-3": "Campaign Identifier", "2-0": "config.name", "2-1": "string", "2-2": "Yes", "2-3": "Name of the campaign", "3-0": "config.description", "3-1": "string", "3-2": "No", "3-3": "Description of the campaign", "4-0": "config.updatedAt", "4-1": "long", "4-2": "Autogenerated", "4-3": "Last modification date (timestamp UTC).", "5-0": "config.startAt", "5-1": "long", "5-2": "Yes", "5-3": "Campaign start date (timestamp UTC).", "6-0": "config.endAt", "6-1": "long", "6-2": "Yes", "6-3": "Campaign end date (timestamp UTC).", "7-0": "config.segmentId", "7-1": "string", "7-2": "No", "7-3": "Id of the target segment.", "10-0": "status", "10-1": "string", "10-2": "Autogenerated", "10-3": "Current status of the campaign.", "11-0": "statusAt", "11-1": "long", "11-2": "Autogenerated", "11-3": "Last status update date (timestamp UTC).", "12-0": "appId", "12-1": "string", "12-2": "Yes", "12-3": "Application key.", "13-0": "numExperiences", "13-1": "integer", "13-2": "Autogenerated", "13-3": "Number of experiences in this campaign.", "8-0": "config.displayCap*", "8-1": "integer", "8-2": "No", "8-3": "Maximum number of experiences that will be triggered within the campaign.", "9-0": "config.displayWaitMs*", "9-1": "integer", "9-2": "No", "9-3": "Minimum delay between experiences triggered within the campaign." }, "cols": 4, "rows": 14 } [/block] [block:callout] { "type": "info", "title": "Advanced settings", "body": "Fields marked with * will not be displayed in the response payload if not set." } [/block] [block:api-header] { "type": "basic", "title": "Sample Campaign Object" } [/block] [block:code] { "codes": [ { "code": "{\n \"createdAt\": 1437405339834,\n \"campaignId\": \"sZHuQ7enqPHJIHKkYnkxMw\",\n \"config\": {\n \"name\": \"Test\",\n \"description\": \"Test Campaign\",\n \"updatedAt\": 1437405339834,\n \"startAt\": 1437405300000,\n \"endAt\": 1438703200000,\n \"segmentId\": null\n },\n \"status\": \"New\",\n \"statusAt\": 1437405339834,\n \"updatedAt\": 1437405339834,\n \"appId\": \"ojvcFIS3kiAyIzcmvN1SvS\",\n \"numExperiences\": 12\n}", "language": "json" } ] } [/block]