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

# Retrieve retained usage by resource, account or execution.

> Details are retained for at least 90 days. Older resource summaries use UTC day buckets; accounts and individual executions are unavailable outside detail retention.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/config/instance/usage/executions
openapi: 3.0.0
info:
  title: RevoEngine Platform API
  description: Official RevoEngine Platform API documentation.
  version: 1.6.4
  contact:
    name: Support
    email: support@revoengine.com
  termsOfService: https://docs.revoengine.com/tos
servers:
  - url: https://api.revoengine.com
    description: Production
security: []
tags:
  - name: Accounts
    description: Users, service accounts, API keys, status, and platform access.
    externalDocs:
      description: Identity and access guide
      url: https://docs.revoengine.com/operate/identity-and-access
  - name: Activity
    description: Snapshot-backed activity and version history.
    externalDocs:
      description: Observability guide
      url: https://docs.revoengine.com/operate/observability
  - name: Agent Memory
    description: Administrative access to durable Agent memory.
    externalDocs:
      description: Agent memory and workspaces guide
      url: https://docs.revoengine.com/ai/memory-and-workspaces
  - name: Agent Plugins
    description: Agent plugin definitions, synchronization, testing, and lifecycle.
    externalDocs:
      description: Agent plugins guide
      url: https://docs.revoengine.com/ai/plugins
  - name: Agent Terminals
    description: Terminal pairing, owner grants, access, and command activity.
    externalDocs:
      description: Connect a terminal guide
      url: https://docs.revoengine.com/ai/terminals
  - name: Agents
    description: >-
      Agent definitions, runs, sessions, inboxes, memory, tools, workspaces, and
      lifecycle.
    externalDocs:
      description: Autonomous Agents guide
      url: https://docs.revoengine.com/ai/agents
  - name: Assistant
    description: >-
      Assistant threads, messages, responses, goals, reports, sharing,
      attachments, and control.
    externalDocs:
      description: Assistant guide
      url: https://docs.revoengine.com/ai/assistant
  - name: Automation
    description: >-
      Jobs, templates, schedules, events, webhooks, execution history, and
      lifecycle.
    externalDocs:
      description: Automation guide
      url: https://docs.revoengine.com/operate/automation
  - name: Chat
    description: Collaborative chat threads, messages, reactions, uploads, and attachments.
    externalDocs:
      description: Team Chat guide
      url: https://docs.revoengine.com/operate/chat
  - name: Component deployments
    description: >-
      Custom Node.js runtime deployment attempts, readiness, activation, and
      rollback.
    externalDocs:
      description: Custom Node.js guide
      url: https://docs.revoengine.com/build/custom-nodejs
  - name: Components
    description: Components, elements, versions, validation, activation, and lifecycle.
    externalDocs:
      description: Components guide
      url: https://docs.revoengine.com/build/components
  - name: Config
    description: Instance configuration, usage, logs, and cache administration.
    externalDocs:
      description: Instance settings guide
      url: https://docs.revoengine.com/platform/instance-settings
  - name: Database Cache
    description: Instance Database cache values and statistics.
    externalDocs:
      description: Database Cache guide
      url: https://docs.revoengine.com/operate/database-cache
  - name: Database Views
    description: Database Views, previews, refreshes, exports, and controlled data actions.
    externalDocs:
      description: Database Views guide
      url: https://docs.revoengine.com/operate/database-views
  - name: Databases
    description: Database definitions, data, audits, exports, cloning, and lifecycle.
    externalDocs:
      description: Databases guide
      url: https://docs.revoengine.com/operate/databases
  - name: Endpoints
    description: >-
      Endpoint definitions, activation, validation, generated OpenAPI, and
      statistics.
    externalDocs:
      description: Endpoints guide
      url: https://docs.revoengine.com/operate/endpoints
  - name: Files
    description: Compatibility file listing, preview, download, and deletion operations.
    externalDocs:
      description: Files compatibility guide
      url: https://docs.revoengine.com/operate/files
  - name: Groups
    description: Groups, membership, avatars, and lifecycle.
    externalDocs:
      description: Groups guide
      url: https://docs.revoengine.com/operate/groups
  - name: Instance Vault
    description: Operations in the Instance Vault Platform API domain.
    externalDocs:
      description: Secrets and Vault guide
      url: https://docs.revoengine.com/operate/secrets
  - name: Me
    description: Current user profile, keys, avatar, and session information.
    externalDocs:
      description: Authentication guide
      url: https://docs.revoengine.com/developers/authentication
  - name: Observability
    description: Authorized execution, performance, graph, and log evidence.
    externalDocs:
      description: Observability guide
      url: https://docs.revoengine.com/operate/observability
  - name: Preferences
    description: User and instance preference values.
    externalDocs:
      description: Platform UI guide
      url: https://docs.revoengine.com/platform/ui-tour
  - name: Role Groups
    description: Role groups, members, assigned roles, and lifecycle.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Roles
    description: Available platform roles and role details.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Search
    description: Cross-domain search over objects visible to the caller.
    externalDocs:
      description: Search and discovery guide
      url: https://docs.revoengine.com/platform/search
  - name: Secrets
    description: >-
      Secret definitions, revision history, explicit rotation, activation,
      reveal, disable, and destruction.
    externalDocs:
      description: Secrets guide
      url: https://docs.revoengine.com/operate/secrets
  - name: Share
    description: >-
      Short-lived authenticated links to supported application routes and grid
      state.
    externalDocs:
      description: Platform API share-link guide
      url: >-
        https://docs.revoengine.com/developers/platform-api#share-application-context
  - name: Storage
    description: >-
      Storage workspaces, folders, objects, upload sessions, signed access, and
      lifecycle.
    externalDocs:
      description: Storage guide
      url: https://docs.revoengine.com/operate/storage
externalDocs:
  description: Documentation
  url: https://docs.revoengine.com
paths:
  /api/v1/config/instance/usage/executions:
    get:
      tags:
        - Config
      summary: Retrieve retained usage by resource, account or execution.
      description: >-
        Details are retained for at least 90 days. Older resource summaries use
        UTC day buckets; accounts and individual executions are unavailable
        outside detail retention.
      operationId: ConfigController_usageExecutions
      parameters:
        - name: from
          required: false
          in: query
          description: >-
            Inclusive lower UTC timestamp for usage analytics. Defaults to the
            start of the current UTC month.
          schema:
            example: '2026-08-01T00:00:00.000Z'
            type: string
        - name: to
          required: false
          in: query
          description: >-
            Exclusive upper UTC timestamp for usage analytics. Defaults to the
            current time.
          schema:
            example: '2026-09-01T00:00:00.000Z'
            type: string
        - name: kind
          required: true
          in: query
          schema:
            type: string
            enum:
              - job
              - endpoint
              - webhook
        - name: view
          required: true
          in: query
          schema:
            type: string
            enum:
              - resources
              - accounts
              - executions
        - name: resourceId
          required: false
          in: query
          schema:
            type: string
        - name: userId
          required: false
          in: query
          schema:
            type: string
        - name: status
          required: false
          in: query
          schema:
            type: string
        - name: skip
          required: false
          in: query
          schema:
            minimum: 0
            maximum: 10000
            default: 0
            type: number
        - name: take
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 50
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceUsageExecutionResponseDto'
      security:
        - bearer: []
components:
  schemas:
    InstanceUsageExecutionResponseDto:
      type: object
      properties:
        selectedPeriod:
          $ref: '#/components/schemas/InstanceUsageSelectedPeriodDto'
        retention:
          $ref: '#/components/schemas/InstanceUsageRetentionDto'
        kind:
          type: string
          enum:
            - job
            - endpoint
            - webhook
        view:
          type: string
          enum:
            - resources
            - accounts
            - executions
        rows:
          type: array
          items:
            $ref: '#/components/schemas/InstanceUsageExecutionRowDto'
        total:
          type: number
        skip:
          type: number
        take:
          type: number
        hasMore:
          type: boolean
        summary:
          nullable: true
          description: >-
            Null when the requested detailed projection is outside retained
            history.
          type: object
          allOf:
            - $ref: '#/components/schemas/InstanceUsageExecutionSummaryDto'
        series:
          type: array
          items:
            $ref: '#/components/schemas/InstanceUsageExecutionSeriesDto'
      required:
        - selectedPeriod
        - retention
        - kind
        - view
        - rows
        - total
        - skip
        - take
        - hasMore
        - summary
        - series
    InstanceUsageSelectedPeriodDto:
      type: object
      properties:
        from:
          type: string
          format: date-time
          example: '2026-08-01T00:00:00.000Z'
        to:
          type: string
          format: date-time
          description: Exclusive upper bound.
          example: '2026-08-14T00:00:00.000Z'
      required:
        - from
        - to
    InstanceUsageRetentionDto:
      type: object
      properties:
        detailDays:
          type: number
          minimum: 90
        detailFrom:
          type: string
          format: date-time
        selectedPeriodDetailed:
          type: boolean
        granularity:
          type: string
          enum:
            - exact
            - day
        effectiveFrom:
          type: string
          format: date-time
        effectiveTo:
          type: string
          format: date-time
      required:
        - detailDays
        - detailFrom
        - selectedPeriodDetailed
        - granularity
        - effectiveFrom
        - effectiveTo
    InstanceUsageExecutionRowDto:
      type: object
      properties:
        count:
          type: number
        processingMs:
          type: number
          nullable: true
          description: >-
            Observed elapsed execution time in milliseconds, not CPU time. Null
            for webhook deliveries, whose source does not measure duration.
        failures:
          type: number
        averageDurationMs:
          type: number
          nullable: true
        id:
          type: string
        name:
          type: string
        userId:
          type: string
          nullable: true
        userName:
          type: string
          nullable: true
        resourceId:
          type: string
          nullable: true
        resourceName:
          type: string
          nullable: true
        occurredAt:
          type: string
          format: date-time
        status:
          type: string
      required:
        - count
        - processingMs
        - failures
        - averageDurationMs
        - id
        - name
    InstanceUsageExecutionSummaryDto:
      type: object
      properties:
        count:
          type: number
        processingMs:
          type: number
          nullable: true
          description: >-
            Observed elapsed execution time in milliseconds, not CPU time. Null
            for webhook deliveries, whose source does not measure duration.
        failures:
          type: number
        averageDurationMs:
          type: number
          nullable: true
      required:
        - count
        - processingMs
        - failures
        - averageDurationMs
    InstanceUsageExecutionSeriesDto:
      type: object
      properties:
        count:
          type: number
        processingMs:
          type: number
          nullable: true
          description: >-
            Observed elapsed execution time in milliseconds, not CPU time. Null
            for webhook deliveries, whose source does not measure duration.
        failures:
          type: number
        averageDurationMs:
          type: number
          nullable: true
        period:
          type: string
          format: date
      required:
        - count
        - processingMs
        - failures
        - averageDurationMs
        - period
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      description: Bearer JWT token or API Key (sk-*).
      type: http

````

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