HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Top N Swarms By Clients Count

get
https://{api-base-url}/monitoring/v1/swarms/clients_count/topn

Get top N Swarm by clients count over a time period.
Possible error_codes for the error responses are

  1. 0001 - General Error.
  2. 0002 - Validation Error. Out of Range value for a query parameter.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by group name

int32

Required top N Swarm count. Default is 5 and maximum is 100

int32

Need information from this timestamp. Timestamp is epoch in seconds. Default is current timestamp minus 3 hours

int32

Need information to this timestamp. Timestamp is epoch in seconds. Default is current timestamp

string

Required sort 'by_peak' or 'by_avg'. Default is 'by_avg'

Responses

401

Unauthorized access

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago