Screen Retention

Purpose

This API will provide the retention data of the screens.

Request URL

https://apptics.zoho.com/cx/api/v1/screen/retention

Request body (JSON object)

Parameter Data TypeAllowed ValuesDescription
startdatestringdatedd-MM-yyyy
enddatestringdatedd-MM-yyyy
modeinteger0,1 0 - Dev, 1- Prod
platformstringiOS/Android/macOS/tvOS/watchOS/Windows max - 1
timezonestring max - 10
granularity* day|week|month 
bundlestringbundle Idmax - 1
include  max - 25
exclude  max - 25

Note: Platform param is mandatory to use bundle param.

Copied{
    "result": {
        "Day-18": {
            "Day-18": 1
        },
        "Day-20": {
            "Day-20": 17
        },
        "Day-10": {
            "Day-10": 3
        },
        "Day-21": {
            "Day-21": 4,
            "Day-22": 1
        },
        "Day-11": {
            "Day-11": 1
        },
        "Day-22": {
            "Day-22": 1
        },
        "Day-12": {
            "Day-12": 1
        },
        "Day-13": {
            "Day-13": 4,
            "Day-14": 1
        },
        "Day-14": {
            "Day-14": 3
        },
        "Day-15": {
            "Day-21": 1,
            "Day-22": 1,
            "Day-15": 3,
            "Day-17": 1
        },
        "Day-16": {
            "Day-16": 2
        },
        "Day-17": {
            "Day-21": 1,
            "Day-22": 1,
            "Day-17": 9
        }
    },
    "status": 200
}