Umami Scripts API

openapi: 3.2.0
info:
  title: Umami Scripts API
  version: 3.3.1
  license:
    identifier: MIT
    name: MIT
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged Scripts across 2 of this provider''s published API definitions: umami-openapi.json, umami-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{instance}
  description: Self-hosted Umami instance (paths begin with /api). Umami Cloud serves the same API at https://api.umami.is/v1 per docs.umami.is/docs/api.
  variables:
    instance:
      default: your-umami-instance.example.com
tags:
- name: Scripts
paths:
  /api/scripts/telemetry:
    get:
      description: Returns JavaScript that sends the application version through a telemetry pixel, or an inactive script when telemetry is disabled.
      operationId: getScriptsTelemetry
      responses:
        '200':
          content:
            text/javascript:
              schema:
                type: string
          description: Successful response. The response shape is inferred as free-form because the handler does not expose a reusable response schema.
      security: []
      summary: Get the installation telemetry script
      tags:
      - Scripts
      x-umami-audience: internal
      x-umami-contract: explicit
      x-umami-source: src/app/api/scripts/telemetry/contract.generated.ts
components:
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only).
      scheme: bearer
      type: http
    shareContext:
      description: Required context header when authenticating with a share token.
      in: header
      name: x-umami-share-context
      type: apiKey
    shareToken:
      description: Signed token returned by a share endpoint.
      in: header
      name: x-umami-share-token
      type: apiKey
externalDocs:
  description: Umami API documentation
  url: https://docs.umami.is/docs/api
x-refined-from:
- umami-openapi.json
- umami-openapi.yml