> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paywithlocus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ledger row counts for a filter

> Counts the rows GET /credits/ledger would page through under the same filters. Cursor pagination can report neither a total nor a per-category split, which the Activity pager and its type chips need.



## OpenAPI

````yaml /api-reference/openapi.json get /credits/ledger/summary
openapi: 3.1.0
info:
  title: Locus Pro API
  description: >-
    Production is live at https://api.paywithlocus.com/api. Stage remains
    available for evaluation and integration testing at
    https://api.stage.paywithlocus.com/api; credentials, balances, and tenant
    data are isolated by environment. Embedded prepaid credits over the Locus
    pay-per-use catalog. Money and top-up amounts use exact decimal strings (up
    to 6dp). Every burn requires an Idempotency-Key header. Management routes
    accept a tenant secret key or authorized dashboard session as shown per
    operation. Widget routes accept an end-user JWT alone; when a publishable
    key is present it must belong to the JWT's tenant. MCP uses OAuth 2.1
    Authorization Code with PKCE by default and also accepts the explicitly
    documented tenant secret key, end-user JWT, or scoped agent connection
    compatibility credentials. Burns accept the execution credentials shown per
    operation. Publishable keys never authorize management or burns by
    themselves.
  version: 0.6.0
servers:
  - url: https://api.paywithlocus.com/api
    description: Production
  - url: https://api.stage.paywithlocus.com/api
    description: Stage — evaluation and integration testing
security:
  - secretKey: []
tags:
  - name: Authentication
    description: Email-verified self-serve account creation and dashboard identity
  - name: Tenants
    description: Tenant profile, keys, and settings (dashboard session or secret key)
  - name: Workspace members
    description: Invite-only human workspace membership and role administration
  - name: Catalog
    description: Enable/disable APIs and set markups
  - name: Custom APIs
    description: >-
      Available when enabled for the workspace. Enterprise BYOK providers and
      schema-backed custom actions
  - name: End users
    description: End-user accounts, tokens, and allocations
  - name: Top-ups
    description: Locus-hosted checkout top-ups and quotes
  - name: Ledger
    description: Burn/top-up history and earnings
  - name: Webhooks
    description: Signed events, delivery inspection, and replay
  - name: Burn
    description: Metered pay-per-use calls
  - name: Travel routing
    description: >-
      Available when enabled for the workspace. Multi-provider flight search,
      no-dispatch planning, and feedback
  - name: MCP
    description: Stateless Streamable HTTP transport and MCP tool-result contracts
  - name: Okibi Identity
    description: >-
      Available when enabled for the workspace. Okibi identity verification and
      scoped native CLI credential bootstrap
  - name: Widget
    description: End-user JWT surface; a matching publishable key is optional
  - name: Agent-native onboarding
    description: >-
      Self-registration, human Stripe funding handoff, and restricted account
      setup for headless agents
  - name: Agent connections
    description: Scoped, expiring, revocable credentials for agent execution
  - name: Capability routing
    description: Outcome-level web search and research across eligible catalog providers
paths:
  /credits/ledger/summary:
    get:
      tags:
        - Ledger
      summary: Ledger row counts for a filter
      description: >-
        Counts the rows GET /credits/ledger would page through under the same
        filters. Cursor pagination can report neither a total nor a per-category
        split, which the Activity pager and its type chips need.
      parameters:
        - name: category
          in: query
          schema:
            type: string
            enum:
              - TOPUP
              - BURN
              - REFUND
              - CLAWBACK
              - FEE
              - ADJUSTMENT
              - ALLOCATION
              - PROMO
        - name: externalUserId
          in: query
          schema:
            $ref: '#/components/schemas/ExternalUserId'
        - name: initiator
          in: query
          schema:
            type: string
          description: >-
            Spender reference <type>:<id>, matching the analytics initiator
            identity.
        - name: provider
          in: query
          schema:
            type: string
        - name: endpoint
          in: query
          schema:
            type: string
          description: Requires provider.
        - name: createdAfter
          in: query
          schema:
            type: string
            format: date-time
        - name: createdBefore
          in: query
          schema:
            type: string
            format: date-time
        - name: attribution.{key}
          in: query
          schema:
            type: string
          description: >-
            Equality filter on metadata.attribution.<key>, one parameter per
            key. Dot form only.
        - name: sourceKey
          in: query
          schema:
            type: string
        - name: account
          in: query
          schema:
            type: string
            enum:
              - platform
      responses:
        '200':
          description: Total row count, plus per-category counts and amounts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantLedgerSummary'
      security:
        - dashboardSession: []
        - secretKey: []
components:
  schemas:
    ExternalUserId:
      type: string
      minLength: 1
      maxLength: 200
      pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$
      description: >-
        Case-sensitive immutable ID in the tenant namespace. Prefer an
        identity-provider subject, not an email address.
    TenantLedgerSummary:
      type: object
      additionalProperties: false
      required:
        - success
        - total
        - byCategory
        - amountUsdcByCategory
        - appliedFilters
      properties:
        success:
          type: boolean
          const: true
        total:
          type: integer
        byCategory:
          type: object
          description: Counts keyed by ledger category; categories with no rows are absent.
          additionalProperties:
            type: integer
        amountUsdcByCategory:
          type: object
          description: >-
            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.
          additionalProperties:
            $ref: '#/components/schemas/DecimalString'
        appliedFilters:
          $ref: '#/components/schemas/AppliedLedgerFilters'
    DecimalString:
      type: string
      pattern: ^\d+(?:\.\d{1,6})?$
      description: >-
        Non-negative exact decimal string with at most six fractional digits.
        Endpoint-specific positivity and amount limits still apply.
    AppliedLedgerFilters:
      type: array
      description: >-
        Names of the narrowing query filters this server applied. An empty array
        means the request did not include a narrowing filter.
      items:
        type: string
        enum:
          - account
          - attribution
          - category
          - createdAfter
          - createdBefore
          - endpoint
          - externalUserId
          - initiator
          - provider
          - sourceKey
      uniqueItems: true
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: Tenant secret key (lcr_…). Server-side only.
    dashboardSession:
      type: http
      scheme: bearer
      description: Locus Pro dashboard session (Cognito).

````