> ## 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.

# API analytics by endpoint

> Per-endpoint API-usage breakdown for your organization — request count, error count, error rate, and p50/p95/p99 latency for each method+path over the selected window. Sort by volume, errors, or latency to find the endpoints worth optimising. Requires an authenticated owner, admin, developer, or viewer session.



## OpenAPI

````yaml /openapi.yaml get /api/v1/developers/api-analytics/endpoints
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
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/developers/api-analytics/endpoints:
    get:
      tags:
        - Developer
      summary: API analytics by endpoint
      description: >-
        Per-endpoint API-usage breakdown for your organization — request count,
        error count, error rate, and p50/p95/p99 latency for each method+path
        over the selected window. Sort by volume, errors, or latency to find the
        endpoints worth optimising. Requires an authenticated owner, admin,
        developer, or viewer session.
      parameters:
        - in: query
          name: window
          schema:
            type: string
            enum:
              - 24h
              - 7d
              - 30d
            default: 24h
          description: Rolling time window to aggregate over.
        - in: query
          name: sort
          schema:
            type: string
            enum:
              - count
              - errors
              - latency
            default: count
          description: Which column to sort the rows by (descending).
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: Maximum number of endpoint rows to return.
      responses:
        '200':
          description: The per-endpoint usage breakdown for the window.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      window:
                        type: string
                        enum:
                          - 24h
                          - 7d
                          - 30d
                      sort:
                        type: string
                        enum:
                          - count
                          - errors
                          - latency
                      rows:
                        type: array
                        items:
                          type: object
                          properties:
                            method:
                              type: string
                            path_pattern:
                              type: string
                            count:
                              type: integer
                            error_count:
                              type: integer
                            error_rate:
                              type: number
                            p50_latency_ms:
                              type: number
                            p95_latency_ms:
                              type: number
                            p99_latency_ms:
                              type: number
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
              example:
                data:
                  window: 24h
                  sort: count
                  rows:
                    - method: POST
                      path_pattern: /api/v1/messages/sms
                      count: 8123
                      error_count: 12
                      error_rate: 0.0015
                      p50_latency_ms: 38
                      p95_latency_ms: 190
                      p99_latency_ms: 421
                meta:
                  request_id: req_9c8f2a1b
                  timestamp: '2026-08-08T12:00:00.000Z'
components:
  schemas:
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
  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_*)

````