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

# Get the runs that billed the most credits in a period

> The runs that billed the most credits between `since` and `until`, highest first, up to `limit`: find what drove a spike in credit use. A credit counts in the period it was billed in, and a run that paused and resumed counts each of its runs on its own. Runs of Agents and Workflows only; chat-agent credits are no run, and `/public-api/billing/usage-by-agent` holds them. Open a run with `GET /public-api/executions/{execution_id}`. A period can be at most 93 days. `credits_cost` prices the credits at the tenant's current price per credit; null when no price is known.



## OpenAPI

````yaml https://api.neoagent.io/public-api/openapi.json get /public-api/billing/usage-by-run
openapi: 3.1.0
info:
  description: >-
    Neo's public contract for the dashboard ChatAgent, partner integrations, and
    MSP automation. Every response is wrapped in a `{data, meta}` envelope;
    errors use `{error: {code, message, details?}, meta: {request_id}}`.
    Authenticate with a `Bearer neo_sk_<env>_<secret>` API key (service account)
    or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user
    feedback links) take a `signature` query parameter instead.
  title: Neo Public API
  version: 1.0.0
servers:
  - url: https://api.neoagent.io
security: []
tags:
  - description: Service metadata — health, OpenAPI.
    name: Meta
  - description: Agents and workflows — read, version history, delete, stats.
    name: Agents
  - description: Agent/workflow execution history, sub-resources, retry/cancel.
    name: Executions
  - description: >-
      Every tool call the tenant's agents made in the last 30 days, within the
      caller's workflow access.
    name: Audit Log
  - description: PSA webhook events and their workflow-match results.
    name: Callbacks
  - description: Technician-in-the-loop approval requests.
    name: TIL requests
  - description: RMM script executions triggered by agents.
    name: RMM scripts
  - description: Dispatch-agent field-update decisions.
    name: Dispatch
  - description: The authenticated tenant.
    name: Tenant
  - description: Agent-builder schema catalogs (raw JSON payloads).
    name: Schemas
  - description: Escalate to the Neo team (HubSpot ticket).
    name: Escalation
  - description: Tenant settings.
    name: Settings
  - description: Tenant API-key management (dashboard JWT only).
    name: API keys
  - description: End-user feedback links (signed-URL auth).
    name: Feedback
  - description: End-client companies (CRUD + bulk-update).
    name: End companies
  - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams or Slack).
    name: Channels
  - description: PSA/RMM/M365 integration status and connection management.
    name: Integrations
  - description: Technician roster (controls TIL routing and paging).
    name: Technicians
  - description: Future runs queued for TRIGGERED agents.
    name: Scheduled work
  - description: Subscription state and customer-facing credit usage (no provider $).
    name: Billing
  - description: Inbox messages and announcements.
    name: Inbox & Comms
  - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog.
    name: Skills
paths:
  /public-api/billing/usage-by-run:
    get:
      tags:
        - Billing
      summary: Get the runs that billed the most credits in a period
      description: >-
        The runs that billed the most credits between `since` and `until`,
        highest first, up to `limit`: find what drove a spike in credit use. A
        credit counts in the period it was billed in, and a run that paused and
        resumed counts each of its runs on its own. Runs of Agents and Workflows
        only; chat-agent credits are no run, and
        `/public-api/billing/usage-by-agent` holds them. Open a run with `GET
        /public-api/executions/{execution_id}`. A period can be at most 93 days.
        `credits_cost` prices the credits at the tenant's current price per
        credit; null when no price is known.
      operationId: public_api.billing_usage_by_run_get
      parameters:
        - description: Start of the period (inclusive), ISO 8601.
          in: query
          name: since
          required: true
          schema:
            type: string
        - description: End of the period (exclusive), ISO 8601. Defaults to now.
          in: query
          name: until
          required: false
          schema:
            type: string
        - description: Only runs of this agent.
          in: query
          name: agent_id
          required: false
          schema:
            type: integer
        - description: How many runs to return, 1 to 1000. Defaults to 20.
          in: query
          name: limit
          required: false
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/RunUsageBreakdown'
                  meta:
                    $ref: '#/components/schemas/SuccessMeta'
                required:
                  - data
                  - meta
                type: object
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Bad request — malformed input.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unauthenticated — missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Forbidden — authenticated but not allowed.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Not found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Conflict — the resource is in a state that blocks this operation.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Request validation failed.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Rate limited — see Retry-After.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Internal server error.
      security:
        - bearerAuth: []
components:
  schemas:
    RunUsageBreakdown:
      description: >-
        The runs that billed the most credits in a period, highest first, up to
        `limit`.
      properties:
        runs:
          items:
            $ref: '#/components/schemas/RunUsage'
          title: Runs
          type: array
        since:
          format: date-time
          title: Since
          type: string
        until:
          format: date-time
          title: Until
          type: string
      required:
        - since
        - until
        - runs
      title: RunUsageBreakdown
      type: object
    SuccessMeta:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        request_id:
          format: uuid
          type: string
        timings_ms:
          additionalProperties:
            type: number
          type: object
        warnings:
          description: >-
            Non-fatal warnings about the created/updated resource (e.g. an
            unhealthy PSA callback).
          items:
            type: string
          type: array
      required:
        - request_id
        - timings_ms
      type: object
    ErrorEnvelope:
      properties:
        error:
          properties:
            code:
              description: Stable machine-readable error code.
              type: string
            details:
              additionalProperties: true
              type: object
            message:
              type: string
          required:
            - code
            - message
          type: object
        meta:
          properties:
            request_id:
              format: uuid
              type:
                - string
                - 'null'
          type: object
      required:
        - error
        - meta
      type: object
    RunUsage:
      description: One run and the credits it billed in the period.
      properties:
        agent_id:
          title: Agent Id
          type: integer
        agent_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Name
        created_at:
          format: date-time
          title: Created At
          type: string
        credits_consumed:
          title: Credits Consumed
          type: integer
        credits_cost:
          anyOf:
            - $ref: '#/components/schemas/CreditsCost'
            - type: 'null'
          description: >-
            What `credits_consumed` cost at the tenant's current price per
            credit. Null when no price is known.
        entity_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Id
        entity_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Entity Number
        execution_id:
          title: Execution Id
          type: string
        status:
          $ref: '#/components/schemas/WorkflowExecutionStatus'
      required:
        - execution_id
        - agent_id
        - agent_name
        - entity_id
        - entity_number
        - status
        - created_at
        - credits_consumed
        - credits_cost
      title: RunUsage
      type: object
    Pagination:
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - next_cursor
        - has_more
      type: object
    CreditsCost:
      description: What a credit figure costs at the tenant's current price per credit.
      properties:
        amount_minor:
          description: Whole minor units (cents, pence), rounded once from credits x price.
          title: Amount Minor
          type: integer
        currency:
          description: Lowercase ISO 4217 code of the billing currency.
          title: Currency
          type: string
      required:
        - amount_minor
        - currency
      title: CreditsCost
      type: object
    WorkflowExecutionStatus:
      enum:
        - NEW
        - SUCCESS
        - RUNNING
        - PAUSED
        - FAILURE
        - SKIPPED
        - TICKET_FILTER_MISMATCH
        - SUB_ENTITIES_ALREADY_PROCESSED
        - CANCELLED
        - WAITING_FOR_USER_INPUT
        - WAITING_FOR_ESCALATION_TIMER
        - WAITING_FOR_ITERATION
        - SUPERSEDED
      title: WorkflowExecutionStatus
      type: string
  securitySchemes:
    bearerAuth:
      description: >-
        `Authorization: Bearer <token>` where `<token>` is either a
        `neo_sk_<env>_<secret>` API key (service account) or a Microsoft Entra
        ID access token (dashboard user).
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.