View number of peak connections

GET {{baseUrl}}/v3/applications/peak_connections?time_dimension=<string>&start_year=<integer>&start_month=<integer>&end_year=<integer>&end_month=<integer>

View number of peak connections

Retrieves the number of concurrently connected devices to Sendbird server during the requested time period.

https://sendbird.com/docs/chat/v3/platform-api/guides/application#2-view-number-of-peak-connections

Request Params

KeyDatatypeRequiredDescription
time_dimensionstring(Required)
start_yearstring(Required)
start_monthstring(Required)
end_yearstring(Required)
end_monthstring(Required)
start_daystring
end_daystring

HEADERS

KeyDatatypeRequiredDescription
Api-Tokenstring(Required)
Acceptstring

RESPONSES

status: OK

{&quot;peak_connections&quot;:[{&quot;date&quot;:&quot;\u003cstring\u003e&quot;,&quot;peak_connections&quot;:&quot;\u003cnumber\u003e&quot;},{&quot;date&quot;:&quot;\u003cstring\u003e&quot;,&quot;peak_connections&quot;:&quot;\u003cnumber\u003e&quot;}]}