Screens

The screens API provides analytics for screen/page navigation and user interface interactions within your application. These endpoints enables analysis of screen usage patterns, user flow tracking, and interface engagement metrics with flexible grouping capabilities.

Download Screens OpenAPI Document

End Points

GET

/screen/multigroup

GET

/screen/retention

Get screens count by group

The get screens Count by group API provides flexible screen analytics with customizable grouping and aggregation capabilities. This endpoint allows you to analyze screen data across multiple dimensions simultaneously, creating hierarchical breakdowns of screen counts based on specified grouping criteria. The API requires a date range and grouping configuration, with optional filtering by platform and screen name. The unique grouping system enables multi-dimensional analysis by combining up to three grouping entities such as device type, platform, bundle, date, app version and country. The response structure dynamically adapts to match your grouping configuration, creating nested JSON hierarchies that reflect the specified group order. For example, grouping by "platform,country,devicetype" returns data organized first by platform, then by country within each platform, and finally by device type within each country. This flexible structure supports complex analytical queries and enables detailed segmentation analysis.
OAuth Scope : JProxy.jmobileapi.ALL

Query Parameters

startdate

string

(Required)

Beginning of date range for data retrieval, required format - dd-MM-yyyy

enddate

string

(Required)

End of date range for data retrieval, required format - dd-MM-yyy

group

string

(Required)

Comma-separated list of grouping entities (devicetype, platform, bundle, date, appversion, country, event). Maximum 3 groups. Response structure follows the specified group order in nested JSON format.

screenname

string

A specific Screen to filter.

platform

string

Platform to filter Screens (iOS, Android, Windows, tvOS, watchOS, macOS). Default - all platforms.

limit

string

Number of results per page. Default and maximum: 500. Use smaller values to limit response size.

offset

string

Starting position for result pagination (default - 0). Increment by limit value for next page (e.g., 501, 1001).

curl --request GET \
  --url 'https://apptics.zoho.com/cx/api/v1/screen/multigroup?startdate=02-08-2025&enddate=24-08-2025&group=platform%2Cdevicetype' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'projectid: 12345689' \
  --header 'zsoid: 10234695'

{
    "result": {
        "iOS": {
            "iPhone": 155248,
            "iPad": 3496
        },
        "Android": {
            "Phone": 40011,
            "Tablet": 1110,
            "Foldables": 1186
        }
    },
    "status": "success"
}

Get device retention count by screens

The get device retention count by screens API measures user retention based on screen interactions within your application. This endpoint analyzes how many devices continue to engage with specific screens over different time periods, providing insights into user retention patterns and screen effectiveness in maintaining user interest. The API requires date range, platform, granularity, and timezone parameters, with optional filtering by application bundle and environment mode. It calculates retention metrics by tracking devices that interact with specified screens during the initial period and return in subsequent periods. The unique screen filtering system allows inclusion or exclusion of specific screens from retention calculations, enabling focused analysis on particular user flows or features.
OAuth Scope : JProxy.jmobileapi.ALL

Query Parameters

startdate

string

(Required)

Beginning of date range for data retrieval, required format - dd-MM-yyyy

enddate

string

(Required)

End of date range for data retrieval, required format - dd-MM-yyy

platform

string

(Required)

Platform to filter screens (iOS, Android, Windows, tvOS, watchOS, macOS). Default - all platforms.

granularity

string

(Required)

Time interval for retention calculation. Values: "day" (daily retention), "week" (weekly retention), "month" (monthly retention).

bundle

string

Application Id/ Bundle Id to filter

mode

string

Environment filter. 0 for development, 1 for production. Default - 1 (production).

timezone

string

(Required)

Timezone for data aggregation.(e.g., "America/New_York", "Asia/Tokyo")

include

string

Comma-separated list of screens to include in retention calculation. Default: all screens in the specified platform. Maximum 25 screens.

exclude

string

Comma-separated list of screens to exclude from retention calculation. Default: no exclusions. Maximum 25 screens.

curl --request GET \
  --url 'https://apptics.zoho.com/cx/api/v1/screen/retention?startdate=02-08-2025&enddate=24-08-2025&platform=Android&granularity=week&timezone=Asia%2FKolkata' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'projectid: 12345689' \
  --header 'zsoid: 10234695'

{
    "result": {
        "week-27": {
            "week-27": 1027,
            "week-28": 990
        },
        "week-28": {
            "week-28": 1100
        }
    },
    "status": 200
}