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

# Entity Usage

> A library entity's activity record: mention and conversation counts, the per-channel split, first/last mention, days since last mention, a daily series, whether mentions are rising or falling, and the window's deal outcomes (presence, win rate, lift) when the workspace has analytics. Use `insights/entity-stats` instead for per-period buckets. Accepts any library entity oId — the type is derived from its prefix. Entity types with no conversation surface (brand voices, skills) return 400 rather than an empty report.



## OpenAPI

````yaml get /api/v2/insights/entity-usage
openapi: 3.0.0
info:
  version: 6.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/insights/entity-usage:
    get:
      tags:
        - Insights
      summary: Entity Usage
      description: >-
        A library entity's activity record: mention and conversation counts, the
        per-channel split, first/last mention, days since last mention, a daily
        series, whether mentions are rising or falling, and the window's deal
        outcomes (presence, win rate, lift) when the workspace has analytics.
        Use `insights/entity-stats` instead for per-period buckets. Accepts any
        library entity oId — the type is derived from its prefix. Entity types
        with no conversation surface (brand voices, skills) return 400 rather
        than an empty report.
      operationId: getEntityUsage
      parameters:
        - schema:
            type: string
            description: >-
              The oId of any library entity. The type is derived from the oId
              prefix (pe_ persona, px_ product, sg_ segment, uu_ use case, cp_
              competitor, …).
          required: true
          description: >-
            The oId of any library entity. The type is derived from the oId
            prefix (pe_ persona, px_ product, sg_ segment, uu_ use case, cp_
            competitor, …).
          name: entityOId
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 365
            default: 90
            description: >-
              Lookback window in days. Scopes the mention/conversation counts,
              the channel split, the daily series and the trend comparison.
              First/last mention stay all-time.
          required: false
          description: >-
            Lookback window in days. Scopes the mention/conversation counts, the
            channel split, the daily series and the trend comparison. First/last
            mention stay all-time.
          name: days
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
            description: >-
              Inclusive YYYY-MM-DD start of an explicit window scoping the
              aggregate counts, overriding `days` for those counts only. Must be
              sent together with `end`. First/last mention stay all-time and the
              daily series stays the full `days` window — so with a range
              narrower than `days`, the counts and the trend cover different
              spans.
          required: false
          description: >-
            Inclusive YYYY-MM-DD start of an explicit window scoping the
            aggregate counts, overriding `days` for those counts only. Must be
            sent together with `end`. First/last mention stay all-time and the
            daily series stays the full `days` window — so with a range narrower
            than `days`, the counts and the trend cover different spans.
          name: start
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
            description: Inclusive YYYY-MM-DD end of the aggregate window.
          required: false
          description: Inclusive YYYY-MM-DD end of the aggregate window.
          name: end
          in: query
      responses:
        '200':
          description: Finding-activity usage for a single library entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      entityOId:
                        type: string
                      entityType:
                        type: string
                        enum:
                          - offering
                          - persona
                          - useCase
                          - competitor
                          - alternative
                          - buyingTrigger
                          - coreFeature
                          - objection
                          - segment
                          - proofPoint
                          - reference
                        description: >-
                          The usage surface the counts are attributed to.
                          Products, services and solutions all report as
                          `offering` — they share one finding pivot.
                      usage:
                        type: object
                        properties:
                          totalFindings:
                            type: number
                          totalEvents:
                            type: number
                          findingsByChannel:
                            type: array
                            items:
                              type: object
                              properties:
                                channel:
                                  type: string
                                count:
                                  type: number
                                eventCount:
                                  type: number
                              required:
                                - channel
                                - count
                                - eventCount
                          firstMentioned:
                            type: string
                            nullable: true
                          lastMentioned:
                            type: string
                            nullable: true
                          daysSinceLastMentioned:
                            type: number
                            nullable: true
                          trend:
                            type: object
                            properties:
                              recentFindings:
                                type: number
                              priorFindings:
                                type: number
                              halfWindowDays:
                                type: number
                              direction:
                                type: string
                                enum:
                                  - rising
                                  - falling
                                  - steady
                                  - no_activity
                            required:
                              - recentFindings
                              - priorFindings
                              - halfWindowDays
                              - direction
                          windowDays:
                            type: number
                          dealOutcomes:
                            type: object
                            properties:
                              dealsWon:
                                type: object
                                properties:
                                  withEntity:
                                    type: number
                                  workspaceTotal:
                                    type: number
                                  share:
                                    type: number
                                    nullable: true
                                required:
                                  - withEntity
                                  - workspaceTotal
                                  - share
                              dealsLost:
                                type: object
                                properties:
                                  withEntity:
                                    type: number
                                  workspaceTotal:
                                    type: number
                                  share:
                                    type: number
                                    nullable: true
                                required:
                                  - withEntity
                                  - workspaceTotal
                                  - share
                              dealsOpen:
                                type: object
                                properties:
                                  withEntity:
                                    type: number
                                  workspaceTotal:
                                    type: number
                                  share:
                                    type: number
                                    nullable: true
                                required:
                                  - withEntity
                                  - workspaceTotal
                                  - share
                              presenceRate:
                                type: number
                                nullable: true
                              winRate:
                                type: number
                                nullable: true
                              winRateWithoutEntity:
                                type: number
                                nullable: true
                              liftScore:
                                type: number
                                nullable: true
                              wonAmount:
                                type: number
                              sentiment:
                                type: object
                                nullable: true
                                properties:
                                  positive:
                                    type: number
                                  neutral:
                                    type: number
                                  negative:
                                    type: number
                                  unknown:
                                    type: number
                                required:
                                  - positive
                                  - neutral
                                  - negative
                                  - unknown
                            required:
                              - dealsWon
                              - dealsLost
                              - dealsOpen
                              - presenceRate
                              - winRate
                              - winRateWithoutEntity
                              - liftScore
                              - wonAmount
                              - sentiment
                          dailyCounts:
                            type: array
                            items:
                              type: number
                          dailyCountsStartDate:
                            type: string
                        required:
                          - totalFindings
                          - totalEvents
                          - findingsByChannel
                          - firstMentioned
                          - lastMentioned
                          - daysSinceLastMentioned
                          - trend
                          - windowDays
                          - dailyCounts
                          - dailyCountsStartDate
                    required:
                      - entityOId
                      - entityType
                      - usage
                required:
                  - data
        '400':
          description: >-
            Malformed oId, an entity type with no usage surface, or
            `start`/`end` sent alone
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
        '404':
          description: No entity with that oId exists in this workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
components:
  schemas:
    Metadata:
      type: object
      properties:
        usage:
          type: number
          default: 0
          example: 0
          description: API usage
        requestId:
          type: string
          example: requestId
          description: Request ID
        message:
          type: string
          example: message
          description: Message
        timestamp:
          type: string
          example: '2021-01-01T00:00:00.000Z'
          description: Timestamp
      required:
        - requestId
        - timestamp
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````

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