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

> Aggregate usage for one action, instruction, or knowledge base item: sessions and replies where it was applied, the available counterpart for apply-rate, and first/last-used timestamps.

# Get usage counts for a resource



## OpenAPI

````yaml get /resource-usage/{resource_type}/{resource_id}/usage-summary
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /resource-usage/{resource_type}/{resource_id}/usage-summary:
    get:
      summary: Get usage counts for a resource
      description: >-
        Aggregate usage for a given action, instruction, or KB item: distinct
        sessions and total replies where it was applied, the available
        counterpart (for instructions, to compute apply-rate), and
        first/last-used timestamps. Optionally bound by a date range.
      operationId: getResourceUsageSummary
      parameters:
        - schema: {}
          in: query
          name: from
          required: false
        - schema: {}
          in: query
          name: to
          required: false
        - schema:
            type: string
            enum:
              - action
              - instruction
              - knowledge
          in: path
          name: resource_type
          required: true
        - schema:
            type: string
          in: path
          name: resource_id
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicResourceUsageSummaryDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    PublicResourceUsageSummaryDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/PublicResourceUsageSummaryDto'
      type: object
      properties:
        session_count:
          type: number
          description: Distinct conversations that used this resource
        applied_sessions:
          type: number
          description: Distinct conversations where the resource was applied
        applied_replies:
          type: number
          description: Total applications/invocations
        available_sessions:
          type: number
          description: >-
            Distinct conversations where an instruction was in context
            (instructions only)
        available_replies:
          type: number
        first_used_at:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 8601 timestamp of first use
        last_used_at:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 8601 timestamp of most recent use
      required:
        - session_count
        - applied_sessions
        - applied_replies
        - available_sessions
        - available_replies
        - first_used_at
        - last_used_at
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````