Skip to content
API Reference

Search is only available in production builds. Try building and previewing the site to test it out locally.

Dashboard

Aggregate the caller's activity events into volume, fee and count totals.

The dashboard endpoint sums the money and count columns of the caller's activity events over a time window, grouped by the dimensions you choose (day, chain, event type, source, platform, quote mint).

Money comes back as integer strings in raw units: USD amounts in micro-USD, native amounts in the chain's base unit (lamports, wei). A bucket that spans chains adds lamports to wei, so group by chain whenever you read amount_native.

GET /dashboard

Returns the caller's activity totals over a window, grouped by the requested dimensions.

Token
Upgraded session token, bound to a license.
Read-only tokens
Allowed.
Retry
Safe to retry

Without since and until, the window is the last 30 days ending now. Without group_by, rows are grouped by event_type.

Query parameters

  • since integer Optional
    Window start in Unix seconds. Defaults to 30 days before until.
  • until integer Optional
    Window end in Unix seconds. Defaults to now.
  • chain string Optional
    Restrict to one chain ID.
  • event_type string Optional
    Restrict to one event type.
  • source string Optional
    Restrict to one event source.
  • group_by string Optional Default event_type
    Comma-separated dimensions: day, chain, event_type, source, platform, quote_mint. The SDK also accepts an array and joins it.
    Exampleday,chain

Returns 200 OK · application/json

  • from integer
    Window start used, in Unix seconds.
  • to integer
    Window end used, in Unix seconds.
  • group_by array<string>
    Grouping columns applied. chain is reported as chain_id.
  • rows array<object>
    One row per group. Only the grouped dimensions are present.
    Child attributes 15
    • day string
      UTC day (YYYY-MM-DD).
    • chain_id string
      Chain ID.
    • event_type string
      Event type.
    • source string | null
      Event source.
    • platform string | null
      Launchpad.
    • quote_mint string | null
      Quote token mint or address.
    • amount_usd string
      Sum in micro-USD.
    • amount_native string
      Sum in native base units.
    • amount_quote string
      Sum in quote token base units.
    • amount_token string
      Sum in launched-token base units.
    • fee_native string
      Fees in native base units. Only in the admin variant of this aggregate.
    • fee_usd string
      Fees in micro-USD. Only in the admin variant of this aggregate.
    • native_mixed boolean
      true when the row spans several chains, so amount_native mixes units.
    • count_sum number
      Sum of the events' item counts.
    • event_count number
      Number of events in the row.

Errors

StatusCodeWhen and what to do
400 bad_request group_by names an unknown dimension. Use day, chain, event_type, source, platform or quote_mint.

Also the common errors: 401 for a missing or expired session or a base token (license_required) and 429 when rate limited.

Web client proxima.dashboard.getDashboard(params) src/lib/proxima/endpoints/dashboard.ts