Chief Tools Logo
Socket Chief API v1

Usage of the apps of the team, recorded by the WebSocket server every minute and aggregated per hour and per day (UTC).


Get the usage summary

GET
https://socket.chief.app/api/v1
/usage
OpenID Connect
or
Bearer (ctp_*)
or
Bearer (ctt_*)

Get the totals of the team since the first day of the period with a breakdown per app, the peak concurrent connections and the connections right now. The period starts on the first day of the current month unless from is given, and always covers whole UTC days.

Get the usage summary › query Parameters

from
​string · date

First day (UTC) of the period, at most 366 days ago. The start of the current month when left out.

Get the usage summary › Responses

UsageSummary

​UsageSummary · required

Get the usage history

GET
https://socket.chief.app/api/v1
/usage/history
OpenID Connect
or
Bearer (ctp_*)
or
Bearer (ctt_*)

Get the usage of the team per day (at most 92 days) or per hour (at most 168 hours), periods without usage included with zeros. Hourly usage is kept for 13 months. The peak connections of a period are the sum of the app peaks, an upper bound for teams with more than one app.

Get the usage history › query Parameters

interval
​string · enum

day for one entry per UTC day, hour for one entry per hour.

Enum values:
day
hour
Default: day
from
​string · date-time

Start of the history (UTC), as a date or date-time. The last 30 days or the last 24 hours when left out.

until
​string · date-time

End of the history (UTC), as a date or date-time, inclusive. Now when left out.

Get the usage history › Responses

UsageHistory

​UsageHistory · required