{"__v":0,"_id":"55ad155e18eefd0d0071d671","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"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"559a61d2dbcfd20d00710b39","user":"55a54dde9c32760d00ca78a8","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_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-20T15:35:58.105Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n  \"firstResult\": 0,\n  \"maxResult\": 10,\n  \"name\": \"Summer%\",\n  \"description\": \"%2015%\",\n  \"group\": null,\n  \"startAt\": 1403256140157,\n  \"endAt\": 1439050000000,\n  \"segmentId\": 'bb0MYHqm-4Jpj4pgAt7ZS9',\n  \"status\": [ \"New\", \"Active\" ]\n}","language":"json"}]},"method":"post","results":{"codes":[{"name":"","code":"[\n  {\n    \"createdAt\": 1437405834339,\n    \"campaignId\": \"nqPHJYnkxMwIHKksZHuQ7e\",\n    \"config\": {\n      \"name\": \"Summer Party 2015\",\n      \"description\": \"Campaign for summer 2015\",\n      \"group\": null,\n      \"updatedAt\": 1437405834339,\n      \"startAt\": 1437405300000,\n      \"endAt\": 1439503800000,\n      \"segmentId\": null\n    },\n    \"status\": \"Active\",\n    \"statusAt\": 1437405339834,\n    \"updatedAt\": 1437405339834,\n    \"appId\": \"ojvcFIS3kiAyIzcmvN1SvS\",\n    \"numExperiences\": 4\n  }\n]","language":"json","status":200},{"name":"","code":"{\n  \"ok\": false,\n  \"request_id\": \"fcf52425-5ade-4d9a-80de-0bc4d910ea32\",\n  \"error\": \"invalid-app-key\"\n}","language":"json","status":400},{"code":"","language":"text","status":403}]},"settings":"","auth":"required","params":[{"_id":"55accc9618eefd0d0071d5a5","ref":"","in":"body","required":true,"desc":"Header: The campaign's Account Id","default":"","type":"string","name":"X-MOCA-Account-Id"},{"_id":"55ad11b7fb7b3c1900373a6d","ref":"","in":"body","required":true,"desc":"Header: The campaign's App Key","default":"","type":"string","name":"X-MOCA-App-Key"}],"url":"/campaigns/search"},"isReference":true,"order":4,"body":"","excerpt":"Retrieves the list of campaigns that match the requested criteria.","slug":"campaignssearch","type":"endpoint","title":"/campaigns/search"}

post/campaigns/search

Retrieves the list of campaigns that match the requested criteria.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

X-MOCA-Account-Id:
required
string
Header: The campaign's Account Id
X-MOCA-App-Key:
required
string
Header: The campaign's App Key

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}