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

# Get insights



## OpenAPI

````yaml GET /locations/{locationId}/insights
openapi: 3.1.0
info:
  title: PickupBell API
  version: 1.0.0
  description: >
    Public REST surface for PickupBell — the AI receptionist for HVAC, plumbing,
    and home-services contractors.


    All requests authenticate via `Authorization: Bearer <uuid>`. Every response
    is JSON with shape `{ "data": … }` (or `{ "error": { "code", "message",
    "details" } }` on failure).


    Only endpoints an API token can successfully call are documented here.
    UI-only operations (create location, invite member, mint / revoke API key,
    billing checkout / portal) require a user session and are not part of the
    public API.
  contact:
    email: support@pickupbell.com
servers:
  - url: https://api.pickupbell.com
    description: >-
      Production (vanity domain — Vercel rewrite proxies to
      app.pickupbell.com/api/v1)
  - url: https://app.pickupbell.com/api/v1
    description: App-domain alias (works without the rewrite)
  - url: http://localhost:3000/api/v1
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Me
  - name: Locations
  - name: Members
  - name: API keys
  - name: Agent
  - name: Business hours
  - name: Call forwarding
  - name: FAQs
  - name: Pricebook
  - name: Calls
  - name: Leads
  - name: Bookings
  - name: Insights
  - name: Notifications
  - name: Integrations
  - name: Webhook endpoints
paths:
  /locations/{locationId}/insights:
    parameters:
      - $ref: '#/components/parameters/WorkspaceId'
    get:
      tags:
        - Insights
      summary: Rolled-up metrics
      operationId: getInsights
      parameters:
        - name: days
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 90
            default: 14
      responses:
        '200':
          description: Insights summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/InsightsSummary'
components:
  parameters:
    WorkspaceId:
      name: locationId
      in: path
      required: true
      schema:
        type: string
      description: Location UUID or slug (e.g. `premier-hvac`).
  schemas:
    InsightsSummary:
      type: object
      properties:
        calls_answered:
          type: integer
        leads_captured:
          type: integer
        revenue_recovered:
          type: number
        spam_blocked:
          type: integer
        emergencies:
          type: integer
        answer_rate_pct:
          type: integer
          minimum: 0
          maximum: 100
        after_hours_calls:
          type: integer
        per_day:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
                format: date
              calls:
                type: integer
              revenue:
                type: number
        per_hour:
          type: array
          items:
            type: object
            properties:
              hour:
                type: integer
                minimum: 0
                maximum: 23
              share:
                type: number
                minimum: 0
                maximum: 1
        services:
          type: array
          items:
            type: object
            properties:
              service:
                type: string
              pct:
                type: integer
                minimum: 0
                maximum: 100
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: uuid
      description: Location-scoped API token from **Settings → API & MCP**.

````