{"__v":0,"_id":"57dbe66c702ffe0e00157c1f","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-09-16T12:32:44.548Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":34,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Enterprise API\"\n}\n[/block]\nGet messages statistics for one or many platforms.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"IMPORTANT\",\n  \"body\": \"As every scheduled request, **/getMsgPlatformsStats** request requires an additional **/getResults** request\"\n}\n[/block]\n**Request body** \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Mandatory\",\n    \"0-3\": \"yes\",\n    \"1-3\": \"yes\",\n    \"0-0\": \"auth\",\n    \"0-1\": \"string\",\n    \"1-0\": \"message\",\n    \"1-1\": \"string\",\n    \"0-2\": \"Pushwoosh API auth token\",\n    \"1-2\": \"Message code. Please check createMessage method for more information\",\n    \"2-0\": \"platforms\",\n    \"2-1\": \"list\",\n    \"2-2\": \"Platform type\",\n    \"2-3\": \"yes\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n## Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"request\\\": {\\n                \\\"auth\\\": \\\"API_ACCESS_TOKEN\\\",\\n                \\\"message\\\": \\\"770E-F29EDD83-EB2D99A9\\\",\\n                \\\"platforms\\\": [1,9,12]\\n               }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**Response body** \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"request_id\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Scheduled request Id. Please check getResults method for more information\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n## Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n    \\\"status_code\\\": 200,\\n    \\\"status_message\\\": \\\"OK\\\",\\n    \\\"response\\\": {\\n        \\\"request_id\\\": \\\"287870092dc23175af5dc48ba1dc7f3c\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**Scheduled (/getResults) response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"status_code\\\": 200,\\n  \\\"status_message\\\": \\\"OK\\\",\\n  \\\"response\\\": {\\n    \\\"formatter\\\": \\\"minutely\\\",\\n    \\\"rows\\\": [\\n      {\\n        \\\"datetime\\\": \\\"2015-09-30 12:54:00\\\",\\n        \\\"action\\\": \\\"send\\\",\\n        \\\"count\\\": \\\"3\\\",\\n      },\\n      {\\n        \\\"datetime\\\": \\\"2015-09-30 12:54:00\\\",\\n        \\\"action\\\": \\\"open\\\",\\n        \\\"count\\\": \\\"2\\\",\\n      },\\n      {\\n        \\\"datetime\\\": \\\"2015-09-30 12:54:00\\\",\\n        \\\"action\\\": \\\"send\\\",\\n        \\\"count\\\": \\\"59\\\",\\n      },\\n      .................\\n    ]\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getmsgplatformsstats","type":"basic","title":"/getMsgPlatformsStats"}

/getMsgPlatformsStats


[block:callout] { "type": "success", "title": "Enterprise API" } [/block] Get messages statistics for one or many platforms. [block:callout] { "type": "warning", "title": "IMPORTANT", "body": "As every scheduled request, **/getMsgPlatformsStats** request requires an additional **/getResults** request" } [/block] **Request body** [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "h-3": "Mandatory", "0-3": "yes", "1-3": "yes", "0-0": "auth", "0-1": "string", "1-0": "message", "1-1": "string", "0-2": "Pushwoosh API auth token", "1-2": "Message code. Please check createMessage method for more information", "2-0": "platforms", "2-1": "list", "2-2": "Platform type", "2-3": "yes" }, "cols": 4, "rows": 3 } [/block] ## Request [block:code] { "codes": [ { "code": "{\n \"request\": {\n \"auth\": \"API_ACCESS_TOKEN\",\n \"message\": \"770E-F29EDD83-EB2D99A9\",\n \"platforms\": [1,9,12]\n }\n}", "language": "json" } ] } [/block] **Response body** [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "request_id", "0-1": "string", "0-2": "Scheduled request Id. Please check getResults method for more information" }, "cols": 3, "rows": 1 } [/block] ## Response [block:code] { "codes": [ { "code": "\n \"status_code\": 200,\n \"status_message\": \"OK\",\n \"response\": {\n \"request_id\": \"287870092dc23175af5dc48ba1dc7f3c\"\n }\n}", "language": "json" } ] } [/block] **Scheduled (/getResults) response** [block:code] { "codes": [ { "code": "{\n \"status_code\": 200,\n \"status_message\": \"OK\",\n \"response\": {\n \"formatter\": \"minutely\",\n \"rows\": [\n {\n \"datetime\": \"2015-09-30 12:54:00\",\n \"action\": \"send\",\n \"count\": \"3\",\n },\n {\n \"datetime\": \"2015-09-30 12:54:00\",\n \"action\": \"open\",\n \"count\": \"2\",\n },\n {\n \"datetime\": \"2015-09-30 12:54:00\",\n \"action\": \"send\",\n \"count\": \"59\",\n },\n .................\n ]\n }\n}", "language": "json" } ] } [/block]