Skip to main content
GET
Get agent overview

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

The agent whose overview is read (ub_ag_…).

Required string length: 18
Pattern: ^ub_ag_

Query Parameters

period
enum<string>

What to count over: all (since ever), 30d (the default) or 7d. The Now block is the same whatever the period.

Available options:
all,
30d,
7d

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required