Skip to main content
GET
Summarize message and event activity

Authorizations

x-api-key
string
header
default:<api-key>
required

API key issued by Centaur.

Query Parameters

groupBy
enum<string>

Group counts by trader (default) or return one overall group with none.

Available options:
trader,
none
interval
enum<string>

Bucket interval: hour, day (default), or week. The window/interval combination is rejected when it would produce more than 168 buckets per group.

Available options:
hour,
day,
week
eventTypes

Filter event counts to specific event types: open, close, increase, or decrease.

traderIds

Positive integer trader IDs only. REST accepts comma-separated values or repeated parameters. MCP accepts an array. Numeric strings become IDs. Maximum 200 non-empty supplied entries per field, including duplicates. Use traderRefs for slugs. Do not supply traderIds and traderRefs together, even if one is empty.

Example:

"7,12"

traderRefs

Trader slugs as strings only. REST accepts comma-separated values or repeated parameters. MCP accepts a string array, e.g. ["alpha-trades", "700"]. Values are trimmed and matched case-insensitively. Numeric text such as "700" is a literal slug, never an ID. Maximum 200 non-empty supplied entries per field, including duplicates. Do not supply traderIds and traderRefs together, even if one is empty. Unknown references match nothing. Retry ambiguous references with a returned numeric ID in traderIds, omitting traderRefs. Find names or handles with trader directory search.

Example:

"alpha-trades"

startTime
string<date-time>

Inclusive ISO-8601 lower time bound. Defaults to 7 days before the applied endTime.

endTime
string<date-time>

Inclusive ISO-8601 upper time bound. Defaults to the current server time.

limit
integer

Maximum number of groups to return, ordered by combined activity. Defaults to 10, maximum 50.

Required range: 1 <= x <= 50

Response

Bounded activity counts per group with per-interval buckets

success
enum<boolean>
required
Available options:
true
data
object
required
requestId
string
required
Example:

"c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8"