Skip to main content
GET
Get agent activity client settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

The settings for this organization.

AgentActivityClientSettings Object

Description

How a client should send batched agent activity for this organization.

batch_wait_seconds
number<double>
required

The minimum gap between two sends from one machine. Send at once when the last send was at least this long ago; otherwise wait until this long after the last send, and send what arrived meanwhile as one request. Between 0 and 300.

max_events_per_request
integer
required

The most events one request to /agent-activity may carry.

max_bytes_per_request
integer<int64>
required

The largest body, in bytes, /agent-activity accepts for a request with more than one event. A request with one event may be up to 1 MiB.

max_requests_per_second
number<double>
required

The rate of batched requests one client should stay under. Can be below 1.

burst_requests
integer
required

How many batched requests a client may send at once before the rate applies. At least 1.

cache_seconds
integer
required

How long these settings may be kept before asking again.