Screens by group

Purpose

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

Request body (JSON)

Parameter	Data type	Allowed values	Description
startdate (mandatory)	string	Date	Beginning of date range for data retrieval, required format - dd-MM-yyyy
enddate (mandatory)	string	Date	End of date range for data retrieval, required format - dd-MM-yyy
group (mandatory)	string		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.
platform	string	iOS, Android, Windows, macOS, tvOS,watchOS	Platform to filter Events (iOS, Android, Windows, tvOS, watchOS, macOS). Default - all platforms.
screenname	string		A specific Screen to filter.
limit	string	number	Number of results per page. Default and maximum: 500. Use smaller values to limit response size.
offset	string	number	Starting position for result pagination (default - 0). Increment by limit value for next page (e.g., 501, 1001).

Request example

Copiedcurl --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'

Response example

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