Skip to main content
GET
Ledger row counts for a filter

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito).

Query Parameters

category
enum<string>
Available options:
TOPUP,
BURN,
REFUND,
CLAWBACK,
FEE,
ADJUSTMENT,
ALLOCATION,
PROMO
externalUserId
string

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$
initiator
string

Spender reference :, matching the analytics initiator identity.

provider
string
endpoint
string

Requires provider.

createdAfter
string<date-time>
createdBefore
string<date-time>
attribution.{key}
string

Equality filter on metadata.attribution., one parameter per key. Dot form only.

sourceKey
string
account
enum<string>
Available options:
platform

Response

200 - application/json

Total row count, plus per-category counts and amounts

success
boolean
required
total
integer
required
byCategory
object
required

Counts keyed by ledger category; categories with no rows are absent.

amountUsdcByCategory
object
required

Unsigned USDC magnitude keyed by ledger category, over the same rows (direction carries the sign). Analytics covers BURN rows only, so a refund total for the same filters comes from here.

appliedFilters
enum<string>[]
required

Names of the narrowing query filters this server applied. An empty array means the request did not include a narrowing filter.

Available options:
account,
attribution,
category,
createdAfter,
createdBefore,
endpoint,
externalUserId,
initiator,
provider,
sourceKey