{"__v":2,"_id":"57f254c987297b200042756a","category":{"__v":17,"_id":"5540ce1c31827a0d007ab1d0","pages":["5540ce1d31827a0d007ab1d2","5540ff9dbb9e762d00f59557","554109205cf9682100d61b65","554109c35cf9682100d61b6b","55a635b6249a40190051d9a2","55bb5de0a8400c2d00873e19","55bb5f4174f10a0d002209a2","55bb607374f10a0d002209a6","55bb614f7313650d00c46e88","55bb61d8a8400c2d00873e20","55bb629874f10a0d002209aa","55bb6318a8400c2d00873e23","55bb63a07313650d00c46e8a","55d5dc84988e130d000b4110","5620b53d40e2c30d0002a848","567cfe57221af70d00fc5498","567d01fd221af70d00fc549c"],"project":"5540ce1b31827a0d007ab1cc","version":"5540ce1c31827a0d007ab1cf","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-29T12:27:08.888Z","from_sync":false,"order":1,"slug":"remote-api","title":"Remote API"},"parentDoc":null,"project":"5540ce1b31827a0d007ab1cc","user":"567bb6833241c20d00b730db","version":{"__v":31,"_id":"5540ce1c31827a0d007ab1cf","project":"5540ce1b31827a0d007ab1cc","createdAt":"2015-04-29T12:27:08.390Z","releaseDate":"2015-04-29T12:27:08.390Z","categories":["5540ce1c31827a0d007ab1d0","5540d91bbb9e762d00f594ad","5540e5f131827a0d007ab212","5540e5febb9e762d00f594d3","5540e61331827a0d007ab213","5540e6195cf9682100d61afa","5540e62631827a0d007ab214","5540e63031827a0d007ab215","5540e63531827a0d007ab216","5540e63e5cf9682100d61afc","5540e6445cf9682100d61afd","5540e64a5cf9682100d61afe","55a4ff5b2e70c0250038050f","55acb28318eefd0d0071d504","55ae1abe8576b92300291c80","55ae453ef302af23000ac109","55af586d555b900d0036d296","55af91dac8a85321007a53c3","55b9fee204775a2f00628071","55b9ff0e04775a2f00628072","55b9ff4604775a2f00628073","55b9ff5fd72d1e1900276a38","55b9ff7f04775a2f00628074","55b9ff90eb08801900f833e5","55b9ffa5d72d1e1900276a39","55b9ffca04775a2f00628075","55b9fffdd72d1e1900276a3a","56bc2f033ee9e70d008b46af","56c2f6efbbf9ec2d00e0fe4f","57595bbb18760817001e8bbe","57d8d9793916800e003dde53"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-03T12:53:29.868Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n  \"request\":{\n    \"auth\":\"AUTH_TOKEN\",\n    \"source\": null, // null, \"CP\", \"API\",\"GeoZone\", \"Beacon\", \"RSS\", \"AutoPush\",\"Twitter\", \"'A/B Test\"\n    \"searchBy\":\"applicationCode\",  // \"\",\"notificationID\", \"notificationCode\", \"applicationCode\", \"campaignCode\"\n    \"value\": \"C8717-703F2\",\n    \"lastNotificationID\":0\n  }\n}","language":"json"}]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"58ab25dcb435800f00c02cab","ref":"","in":"body","required":true,"desc":"API access token from the Pushwoosh control panel","default":"","type":"string","name":"request.auth"},{"_id":"58ab25dcb435800f00c02caa","ref":"","in":"body","required":false,"desc":"Push history source. Could be null or: \"CP\", \"API\",\"GeoZone\", \"Beacon\", \"RSS\", \"AutoPush\", \"Twitter\", \"'A/B Test\"","default":"null","type":"string","name":"request.source"},{"_id":"58ab25dcb435800f00c02ca9","ref":"","in":"body","required":false,"desc":"Possible values to search by. Could be null or: \"notificationID\", \"notificationCode\", \"applicationCode\", \"campaignCode\"","default":"null","type":"string","name":"request.searchBy"},{"_id":"58ab25dcb435800f00c02ca8","ref":"","in":"body","required":false,"desc":"Search value set according to the \"searchBy\" field.","default":"null","type":"string","name":"request.value"},{"_id":"58ab25dcb435800f00c02ca7","ref":"","in":"body","required":false,"desc":"Used for pagination. Last messageId from the previous call. See more below.","default":"","type":"string","name":"request.lastNotificationID"}],"url":"/getPushHistory"},"isReference":false,"order":55,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Enterprise API\"\n}\n[/block]\nThis method will return 1000 messages from the account sorted by message Id. To get the second page specify the last message Id in the *lastNotificationId* parameter.","excerpt":"Gets push history via the API.","slug":"getpushhistory","type":"endpoint","title":"/getPushHistory"}

post/getPushHistory

Gets push history via the API.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

request.auth:
required
string
API access token from the Pushwoosh control panel
request.source:
stringnull
Push history source. Could be null or: "CP", "API","GeoZone", "Beacon", "RSS", "AutoPush", "Twitter", "'A/B Test"
request.searchBy:
stringnull
Possible values to search by. Could be null or: "notificationID", "notificationCode", "applicationCode", "campaignCode"
request.value:
stringnull
Search value set according to the "searchBy" field.
request.lastNotificationID:
string
Used for pagination. Last messageId from the previous call. See more below.

Examples


Documentation

[block:callout] { "type": "success", "title": "Enterprise API" } [/block] This method will return 1000 messages from the account sorted by message Id. To get the second page specify the last message Id in the *lastNotificationId* parameter.

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