Statistics API

getMsgStats

post
https://cp.pushwoosh.com/json/1.3
/getMsgStats
/getMsgStats
For Private Offering subscriptions only.
Example
1
{
2
"request":{
3
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
"message": "xxxx-xxxxxxx-xxxxxx" // message code obtained in /createMessage request
5
}
6
}
Copied!
Like every scheduled request, /getMsgStats request requires an additional /getResults request
Response body:
Field
Type
Description
request_id
string
Scheduled request Id. Please check/getResults method for more information
Scheduled (/getResults) response:
Example
1
{
2
"status_code": 200,
3
"status_message": "OK",
4
"response": {
5
"formatter": "minutely",
6
"rows": [
7
{
8
"datetime": "2015-09-30 12:54:00",
9
"action": "send",
10
"count": "3"
11
},
12
{
13
"datetime": "2015-09-30 12:54:00",
14
"action": "open",
15
"count": "2"
16
},
17
{
18
"datetime": "2015-09-30 12:54:00",
19
"action": "send",
20
"count": "59"
21
}
22
],
23
24
// conversion (if goal tracking is allowed)
25
"conversion": {
26
"send": 10,
27
"open": 5,
28
"events": [
29
{"uid": 1, "event": "event name", "hits": 5, "conversion": "100%",
30
"revenue": 15.34}
31
]
32
}
33
}
34
}
Copied!

getMsgPlatformStats

post
https://cp.pushwoosh.com/json/1.3
/getMsgPlatformsStats
/getMsgPlatformsStats
For Private Offering subscriptions only.
Example
1
{
2
"request":{
3
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
"message": "xxxx-xxxxxxx-xxxxxx", // message code or message ID
5
"platforms":[1,2,3,4,5] // list of platform types. Please see /registerDevice for the complete list of platform types
6
}
7
}
Copied!
As every scheduled request, /getMsgPlatformsStats request requires an additional /getResults request.
Response body:
Field
Type
Description
request_id
string
Scheduled request Id. Please check/getResults method for more information
Scheduled (/getResults) response:
Example
1
{
2
"status_code": 200,
3
"status_message": "OK",
4
"response": {
5
"formatter": "minutely",
6
"rows": [
7
{
8
"datetime": "2015-09-30 12:54:00",
9
"action": "send",
10
"count": "3",
11
},
12
{
13
"datetime": "2015-09-30 12:54:00",
14
"action": "open",
15
"count": "2",
16
},
17
{
18
"datetime": "2015-09-30 12:54:00",
19
"action": "send",
20
"count": "59",
21
},
22
.................
23
]
24
}
25
}
Copied!

getApplicationSubscribersStats

post
https://cp.pushwoosh.com/json/1.3
/getApplicationSubscribersStats
/getApplicationSubscribersStats
For Private Offering subscriptions only.
Example
1
{
2
"request": {
3
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
"application": "XXXXX-XXXXX" // Pushwoosh application code
5
}
6
}
Copied!

getAppStats

post
https://cp.pushwoosh.com/json/1.3
/getAppStats
/getAppStats
For Private Offering subscriptions only.
Example
1
{
2
"request": {
3
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
"application": "XXXXX-XXXXX", // Pushwoosh application code
5
"datefrom": "2013-06-04 00:00:00", // date and time, start of the reporting period
6
"dateto": "2013-06-07 00:00:00" // date and time, end of the reporting period
7
}
8
}
9
10
Copied!
Statistic displays registered actions for application, device or message, for the timeframe specified.
Reports are automatically aggregated using the following rules: yearly > 1 year monthly > 1 month daily > 1 day hourly > 3 hours minutely in other cases.
Actions: Application Level: open, install
Device Level: register, unregister
Message level: send, open
All statistics objects have the same format:
Field
Type
Description
formatter
string
report scale: yearly, monthly, daily, hourly, minutely
rows
list
report rows
Each of the report rows is a dictionary:
Field
Type
Description
count
int
registered actions count
action
string
registered action
datetime
string
Formatted date: Y-m-d H:i:s
As every scheduled request, /getAppStats request requires an additional /getResults request.
Response body:
Field
Type
Description
request_id
string
Scheduled request ID. Please check /getResults method for more information.
Scheduled (/getResults) response body:
Field
Type
Description
applications
dictionary
statistics for applications
devices
dictionary
statistics for devices
messages
dictionary
statistics for messages
Example
1
{
2
"error": {
3
"code": 0,
4
"message": "OK"
5
},
6
"json_data": {
7
"applications": {
8
"formatter": "hourly",
9
"rows": [{
10
"count": 0,
11
"action": "open",
12
"datetime": "2013-06-06 00:00:00"
13
}, ...
14
]
15
}
16
}
17
}
Copied!

getCampaignStats

post
https://cp.pushwoosh.com/json/1.3
/getCampaignStats
/getCampaignStats
For Private Offering subscriptions only.
1
{
2
"request": {
3
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
"campaign": "XXXXX-XXXXX", // campaign ID
5
"datefrom": "Y-m-d H:i:s", // date and time, start of the reporting period
6
"dateto": "Y-m-d H:i:s" // date and time, end of the reporting period
7
}
8
}
Copied!
As every scheduled request, /getCampaignStats request requires an additional /getResults request.
/getResults response:
Example
1
{
2
"status_code": 200,
3
"status_message": "OK",
4
"response": {
5
"formatter": "hourly",
6
"rows": [
7
{
8
"count": 0,
9
"action": "open",
10
"datetime": "2018-05-09 00:00:00",
11
"platformid": 14
12
},
13
{
14
"count": 0,
15
"action": "send",
16
"datetime": "2018-05-09 00:00:00",
17
"platformid": 14
18
},
19
{
20
"count": 0,
21
"action": "send",
22
"datetime": "2018-05-11 00:00:00",
23
"platformid": 14
24
}
25
],
26
27
// conversion (if goal tracking is allowed)
28
"conversion": {
29
"send": 10,
30
"open": 5,
31
"events": [
32
{"uid": 1, "event": "event name", "hits": 5, "conversion": "100%",
33
"revenue": 15.34}
34
]
35
}
36
}
37
}
Copied!

getEventStatistics

post
https://cp.pushwoosh.com/json/1.3
/getEventStatistics
/getEventStatistics
For Private Offering subscriptions only.
1
{
2
"request" : {
3
"auth":"yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
"application": "XXXXX-XXXXX", // Pushwoosh application code
5
"event" : "Event name", // the name of Event exactly as created in Pushwoosh Control Panel
6
"date_from" : "2018-09-12",
7
"date_to" : "2018-09-12",
8
"attributes" : [ // optional
9
{
10
"name": "attributeName",
11
"operator" : "EQ",
12
"values": ["val"]
13
}
14
]
15
}
16
}
Copied!
Like every scheduled request, /getEventStatistics request requires an additional /getResults request
Response body:
Field
Type
Description
request_id
string
Scheduled request Id. Please check/getResults method for more information
Scheduled (/getResults) response:
Example
1
{
2
"status_code": 200,
3
"status_message": "OK",
4
"response": [
5
{
6
"date": "2018-09-12 00:00",
7
"count": 12
8
},
9
{
10
"date": "2018-09-12 01:00",
11
"count": 2
12
},
13
{
14
"date": "2018-09-12 02:00",
15
"count": 4
16
},
17
{
18
"date": "2018-09-12 03:00",
19
"count": 8
20
},
21
{
22
"date": "2018-09-12 04:00",
23
"count": 9
24
},
25
{
26
"date": "2018-09-12 05:00",
27
"count": 2
28
},
29
{
30
"date": "2018-09-12 06:00",
31
"count": 0
32
},
33
{
34
"date": "2018-09-12 07:00",
35
"count": 0
36
},
37
{
38
"date": "2018-09-12 08:00",
39
"count": 0
40
},
41
{
42
"date": "2018-09-12 09:00",
43
"count": 0
44
},
45
{
46
"date": "2018-09-12 10:00",
47
"count": 0
48
},
49
{
50
"date": "2018-09-12 11:00",
51
"count": 0
52
},
53
{
54
"date": "2018-09-12 12:00",
55
"count": 0
56
},
57
{
58
"date": "2018-09-12 13:00",
59
"count": 0
60
},
61
{
62
"date": "2018-09-12 14:00",
63
"count": 0
64
},
65
{
66
"date": "2018-09-12 15:00",
67
"count": 0
68
},
69
{
70
"date": "2018-09-12 16:00",
71
"count": 0
72
},
73
{
74
"date": "2018-09-12 17:00",
75
"count": 0
76
},
77
{
78
"date": "2018-09-12 18:00",
79
"count": 0
80
},
81
{
82
"date": "2018-09-12 19:00",
83
"count": 0
84
},
85
{
86
"date": "2018-09-12 20:00",
87
"count": 0
88
},
89
{
90
"date": "2018-09-12 21:00",
91
"count": 0
92
},
93
{
94
"date": "2018-09-12 22:00",
95
"count": 0
96
},
97
{
98
"date": "2018-09-12 23:00",
99
"count": 0
100
}
101
]
102
}
Copied!

getTagStats

post
https://cp.pushwoosh.com/json/1.3
/getTagStats
/getTagStats
For Private Offering subscriptions only.
Example
1
{
2
"request":{
3
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
"tag": "TAG_NAME",
5
"applications": ["APPLICATION_1", "APPLICATION_2", "APPLICATION_3"] // optional. Specify only when the tag is app specific
6
}
7
}
Copied!
As every scheduled request, getTagStats request requires an additional /getResults request.
/getResults response:
1
{
2
"status_code": 200,
3
"status_message": "OK",
4
"response": {
5
"fileName": "DIRECT_FILE_URL.csv" // direct link to the csv file
6
}
7
}
Copied!
Received file is a csv file with a semicolon ";" separator.
csv file content example:
1
13C2B-72C62;ua_settingpushbod;3
2
13C2B-72C62;ua_settingpushhealth;3
3
13C2B-72C62;ua_settingpushstrength;3
4
13C2B-72C62;ua_settingpushupdate;2
Copied!
Last modified 12d ago