Results Format
The results are formatted in a JSON object which contains an element for each segment. Each of these elements is an object which contains an element for each day/week/month after the install date. Each of these sub-elements is an object which contains the following properties:
| • | engaged—The number of users that were still active by this day/week/month |
| • | engagedPercent—The percentage of users that were still active by this day/week/month |
| • | lost—The number of users that got lost by this day/week/month |
| • | lostPercent—The percentage of users that got lost by this day/week/month |
Example Request
POST /reporting/engagement/churnAndEngagement HTTP/1.1
Host: api.revulytics.com
Content-Type: application/json
Accept: application/json
{
"user": "testuser@test.com",
"sessionId": "VSB8E2BzSC2eZSJm4QmTpA",
"productId": 12345678901,
"startDate": "2017-11-01",
"stopDate": "2018-02-31",
"daysUntilDeclaredLost": 30,
"dateSplit": "month",
"segmentBy": "installationMonth"
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "OK",
"results": {
"2017-11-01": {
"0": {
"engaged": 6,
"engagedPercent": 100,
"lost": 0,
"lostPercent": 0
},
"1": {
"engaged": 6,
"engagedPercent": 100,
"lost": 0,
"lostPercent": 0
},
"2": {
"engaged": 6,
"engagedPercent": 100,
"lost": 0,
"lostPercent": 0
},
"3": {
"engaged": 5,
"engagedPercent": 83.3,
"lost": 1,
"lostPercent": 16.7
}
},
"2017-12-01": {
"0": {
"engaged": 29,
"engagedPercent": 100,
"lost": 0,
"lostPercent": 0
},
"1": {
"engaged": 28,
"engagedPercent": 96.6,
"lost": 1,
"lostPercent": 3.4
},
"2": {
"engaged": 28,
"engagedPercent": 96.6,
"lost": 1,
"lostPercent": 3.4
}
},
"2018-01-01": {
"0": {
"engaged": 2131,
"engagedPercent": 100,
"lost": 0,
"lostPercent": 0
},
"1": {
"engaged": 2073,
"engagedPercent": 97.3,
"lost": 58,
"lostPercent": 2.7
}
},
"2018-02-01": {
"0": {
"engaged": 1655,
"engagedPercent": 100,
"lost": 0,
"lostPercent": 0
}
}
}
}