Get project's highest online user count in specified time period

Last updated：2022-02-25 17:04

1 Description

Gets the highest number of online users of a project in a period of time.

Request method: POST
Request endpoint:

Service environment Rate limit Endpoint

Production 1 request/second https://roomkit-api.zego.im/statistic/v2/project/get_max_online
Transmission protocol: HTTPS

Service environment	Rate limit	Endpoint
Production	1 request/second	https://roomkit-api.zego.im/statistic/v2/project/get_max_online

Parameter	Type	Required	Example	Description
secret_id	Int64	Yes	12580	The Secret ID assigned to your project by ZEGO.
access_token	String	Yes	"CIE7hNPK6Y55DeUJBSDrInP"	The server access token obtained via the `get_access_token` request.
pid	Int64	Yes	1200	The Product ID assigned to your project by ZEGO.
begin_timestamp	Int64	Yes	1616489840	Query start time, in seconds.
end_timestamp	Int64	Yes	1616490214	Query end time, in seconds.

The query time range cannot exceed 72 hours at most.

{
    "secret_id": 12580,
    "access_token": "access_token",
    "pid": 1200,
    "begin_timestamp": 1616489840,
    "end_timestamp": 1616490214
}

Parameter	Type	Example	Description
ret	Object	-	The returned status of the request.
ret.code	Int	0	The returned code.
ret.message	String	"succeed"	The returned message.
data	Object	-	The returned data of the request.
data.max_online	Int64	6	The highest number of online users of the project in the given time period.
data.pid	Int64	123	Product ID.

{
    "ret": {
        "code": 0,
        "message": "succeed"
    },
    "data": {
        "max_online": 3,
        "pid": 1200
    }
}