openapi: 3.2.0
info:
  title: Hookbase Analytics API
  version: 1.0.0
  description: Official OpenAPI 3.0 specification for the Hookbase webhook relay platform. Generated from the maintained Postman collection. Authenticate with an API key (whr_ prefix) as a Bearer token.
  contact:
    name: Hookbase
    url: https://www.hookbase.app
servers:
- url: https://api.hookbase.app
  description: Production
security:
- bearerAuth: []
tags:
- name: Analytics
paths:
  /api/analytics/dashboard:
    get:
      tags:
      - Analytics
      summary: Dashboard
      operationId: analytics_dashboard
      parameters:
      - name: range
        in: query
        required: false
        schema:
          type: string
        example: 7d
      responses:
        '200':
          description: Successful response
      description: Aggregated dashboard metrics for the org over a range (?range=).
  /api/analytics:
    get:
      tags:
      - Analytics
      summary: Root analytics
      operationId: analytics_root_analytics
      responses:
        '200':
          description: Successful response
      description: Top-level analytics summary for the org.
  /api/analytics/overview:
    get:
      tags:
      - Analytics
      summary: Overview
      operationId: analytics_overview
      responses:
        '200':
          description: Successful response
      description: High-level overview counters (events, deliveries, success rate).
  /api/analytics/events:
    get:
      tags:
      - Analytics
      summary: Events over time
      operationId: analytics_events_over_time
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: string
        example: '7'
      responses:
        '200':
          description: Successful response
      description: Event volume bucketed over time (?days=).
  /api/analytics/deliveries:
    get:
      tags:
      - Analytics
      summary: Delivery stats
      operationId: analytics_delivery_stats
      responses:
        '200':
          description: Successful response
      description: Delivery outcome counts and rates.
  /api/analytics/timeline:
    get:
      tags:
      - Analytics
      summary: Timeline
      operationId: analytics_timeline
      parameters:
      - name: range
        in: query
        required: false
        schema:
          type: string
        example: 24h
      responses:
        '200':
          description: Successful response
      description: Event/delivery timeline for a range (?range=).
  /api/analytics/latency:
    get:
      tags:
      - Analytics
      summary: Latency percentiles
      operationId: analytics_latency_percentiles
      parameters:
      - name: range
        in: query
        required: false
        schema:
          type: string
        example: 7d
      responses:
        '200':
          description: Successful response
      description: Delivery latency percentiles (p50/p95/p99) for a range.
  /api/analytics/latency/distribution:
    get:
      tags:
      - Analytics
      summary: Latency distribution
      operationId: analytics_latency_distribution
      parameters:
      - name: range
        in: query
        required: false
        schema:
          type: string
        example: 7d
      responses:
        '200':
          description: Successful response
      description: Histogram of delivery latency for a range.
  /api/analytics/errors:
    get:
      tags:
      - Analytics
      summary: Errors
      operationId: analytics_errors
      parameters:
      - name: range
        in: query
        required: false
        schema:
          type: string
        example: 7d
      responses:
        '200':
          description: Successful response
      description: Top delivery errors for a range.
  /api/analytics/sources:
    get:
      tags:
      - Analytics
      summary: Sources
      operationId: analytics_sources
      parameters:
      - name: range
        in: query
        required: false
        schema:
          type: string
        example: 7d
      responses:
        '200':
          description: Successful response
      description: Per-source activity breakdown for a range.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Hookbase API key with the whr_ prefix.