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

# Get Interview Usage

> Read bounded usage with the same resolved scope and totals as the dashboard.



## OpenAPI

````yaml /api-reference/openapi.json get /api/public/v1/usage/interviews
openapi: 3.1.0
info:
  title: User Intuition Public API
  description: >-
    ## Public Integration API


    Programmatic access to User Intuition for external integrators: manage
    studies, participants, interviews, reports, and panels.


    ### Authentication


    All endpoints require a Bearer token — either an API key (prefixed `ui_sk_`,
    created in the dashboard) or a dashboard JWT:


    ```

    Authorization: Bearer <ui_sk_… or JWT>

    ```


    ### Base URLs


    - **Production:** `https://api.userintuition.ai`

    - **Staging:** `https://staging.userintuition.ai`


    ### Support


    For API support, contact support@userintuition.ai
  version: 1.0.0
  contact:
    name: User Intuition Support
    email: support@userintuition.ai
servers:
  - url: https://api.userintuition.ai
    description: Production
  - url: https://staging.userintuition.ai
    description: Staging
security:
  - BearerAuth: []
paths:
  /api/public/v1/usage/interviews:
    get:
      tags:
        - public-usage
      summary: Get Interview Usage
      description: >-
        Read bounded usage with the same resolved scope and totals as the
        dashboard.
      operationId: getInterviewUsage
      parameters:
        - name: start_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: Inclusive UTC start date
            title: Start Date
          description: Inclusive UTC start date
        - name: end_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date
              - type: 'null'
            description: Inclusive UTC end date
            title: End Date
          description: Inclusive UTC end date
        - name: cadence
          in: query
          required: false
          schema:
            anyOf:
              - enum:
                  - daily
                  - weekly
                  - monthly
                type: string
              - type: 'null'
            title: Cadence
        - name: app_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: App Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicInterviewUsage'
        '422':
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        default:
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
components:
  schemas:
    PublicInterviewUsage:
      properties:
        total_interviews:
          type: integer
          title: Total Interviews
        total_units:
          type: number
          title: Total Units
        usage_stats:
          items:
            $ref: '#/components/schemas/PublicUsageBucket'
          type: array
          title: Usage Stats
        scope:
          $ref: '#/components/schemas/UsageStatsScope'
      additionalProperties: false
      type: object
      required:
        - total_interviews
        - total_units
        - usage_stats
        - scope
      title: PublicInterviewUsage
    PublicApiErrorResponse:
      type: object
      required:
        - detail
        - error
      properties:
        detail:
          description: Legacy error detail; may be a string, list, or object.
        error:
          $ref: '#/components/schemas/PublicApiError'
    PublicUsageBucket:
      properties:
        date:
          type: string
          format: date
          title: Date
        interviews:
          type: integer
          title: Interviews
          default: 0
        audio_interviews:
          type: integer
          title: Audio Interviews
          default: 0
        video_interviews:
          type: integer
          title: Video Interviews
          default: 0
        chat_interviews:
          type: integer
          title: Chat Interviews
          default: 0
        synthetic_respondents:
          type: integer
          title: Synthetic Respondents
          default: 0
        units:
          type: number
          title: Units
          default: 0
      additionalProperties: false
      type: object
      required:
        - date
      title: PublicUsageBucket
    UsageStatsScope:
      properties:
        app_id:
          type: string
          title: App Id
          description: Resolved app used for this query
        start_date:
          type: string
          format: date
          title: Start Date
          description: Inclusive start date in UTC
        end_date:
          type: string
          format: date
          title: End Date
          description: Inclusive end date in UTC
        cadence:
          type: string
          enum:
            - daily
            - weekly
            - monthly
          title: Cadence
      type: object
      required:
        - app_id
        - start_date
        - end_date
        - cadence
      title: UsageStatsScope
    PublicApiError:
      type: object
      required:
        - code
        - message
        - field
        - request_id
        - outcome
        - recovery_action
        - docs_url
      properties:
        code:
          type: string
        message:
          type: string
        field:
          anyOf:
            - type: string
            - type: 'null'
        request_id:
          type: string
          format: uuid
        outcome:
          type: string
          enum:
            - not_started
            - failed
            - unknown
        recovery_action:
          type: string
        docs_url:
          type: string
          format: uri
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````