API Stats

API Stats

The API Stats endpoints provide analytics on configured API call counts for your application. This suite enables multi-dimensional analysis of API usage with customizable grouping by date, platform, bundle, country, app version, device type, and API name.

Download API Stats OpenAPI Document
End Points
Get API count by group

Get API count by group

Retrieves configured API call counts for a given date range with customizable grouping and aggregation. The grouping system supports combining up to two grouping entities such as date, platform, bundle, country, app version, device type, and API name. The response format is controlled by the responseformat parameter — use nestedjson for hierarchical output or csvjson for flat output. The response structure dynamically adapts to match the specified grouping configuration.
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-yyyy.
responseformat
string
(Required)
Format of the response data. Use nestedjson for hierarchical output or csvjson for flat output.
group
string
(Required)
Comma-separated list of grouping entities. Allowed values: date, platform, bundle, country, appversion, devicetype, api. Minimum 1, maximum 2 groups. Response structure follows the specified group order in nested JSON format.
apiname
string
Filter results by a specific API name.
limit
integer
Number of results per page. Default and maximum: 500.
offset
integer
Starting position for result pagination (default: 0). Increment by limit value for next page.

Headers

zsoid
string
(Required)
Portal ID
projectid
string
(Required)
Project ID

Request Example

Click to copy
curl --request GET \ --url 'https://apptics.zoho.com/cx/api/v1/api/multigroup?startdate=01-07-2024&enddate=31-07-2024&responseformat=nestedjson&group=date%2Cplatform' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'projectid: 12345689' \ --header 'zsoid: 10234695'

Response Example

{ "result": { "iOS": { "01-07-2024": 22, "02-07-2024": 9, "03-07-2024": 97 }, "Android": { "01-07-2024": 69, "02-07-2024": 222, "03-07-2024": 20 } }, "status": 200 }
{ "result": { "2.1.0": 548, "2.0.5": 181, "1.9.3": 33 }, "status": 200 }