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

# Room usage analytics

> Aggregate video room usage + engagement for the calling tenant over a date window (default last 30 days): total sessions, room-minutes, average/peak concurrent participants, recording success rate, and join failures. Returns an org-wide `summary` plus a per-UTC-day `daily` time series for sessions-over-time charts. Read-only; scoped on `video:read` (or `video:write` as a superset).



## OpenAPI

````yaml /openapi.yaml get /api/v1/video/rooms-analytics/usage
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/video/rooms-analytics/usage:
    get:
      tags:
        - Video
      summary: Room usage analytics
      description: >-
        Aggregate video room usage + engagement for the calling tenant over a
        date window (default last 30 days): total sessions, room-minutes,
        average/peak concurrent participants, recording success rate, and join
        failures. Returns an org-wide `summary` plus a per-UTC-day `daily` time
        series for sessions-over-time charts. Read-only; scoped on `video:read`
        (or `video:write` as a superset).
      parameters:
        - schema:
            type: string
          in: query
          name: from
          required: false
          description: Window start (ISO 8601 date-time). Defaults to 30 days before `to`.
        - schema:
            type: string
          in: query
          name: to
          required: false
          description: Window end (ISO 8601 date-time). Defaults to now.
      responses:
        '200':
          description: Room usage analytics envelope
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                description: Room usage analytics envelope
                properties:
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      window:
                        type: object
                        additionalProperties: true
                        properties:
                          from:
                            type: string
                            format: date-time
                          to:
                            type: string
                            format: date-time
                      summary:
                        type: object
                        additionalProperties: true
                        description: Org-wide totals for the window
                        properties:
                          total_sessions:
                            type: integer
                          total_room_seconds:
                            type: integer
                          total_room_minutes:
                            type: integer
                          avg_peak_participants:
                            type: number
                          max_peak_participants:
                            type: integer
                          total_join_events:
                            type: integer
                          recordings_started:
                            type: integer
                          recordings_succeeded:
                            type: integer
                          recording_success_rate:
                            type:
                              - 'null'
                              - number
                          join_failures:
                            type: integer
                          error_sessions:
                            type: integer
                      daily:
                        type: array
                        description: One bucket per UTC day (sessions-over-time series)
                        items:
                          type: object
                          additionalProperties: true
                          properties:
                            date:
                              type: string
                            sessions:
                              type: integer
                            room_minutes:
                              type: integer
                            avg_peak_participants:
                              type: number
                            max_peak_participants:
                              type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: >-
                          Unique request identifier (also returned in
                          X-Request-Id header)
                      timestamp:
                        type: string
                        format: date-time
                        description: ISO 8601 UTC timestamp of the response
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````