API documentation for Umami Analytics.
This repo maintains an OpenAPI spec that tracks changes in Umami and publishes documentation via GitHub Pages (Redocly).

Docs

Umami version Pages deployed

• npm run start Start live server
• npm run build Build bundle.yaml in dist
• npm run build:docs Create the html page based on template
• npm run test Run lint test and check openapi
• npm run arazzo:build Generate arazzo test file
• npm run arazzo:test -- --input api-key={YOUR_API_KEY} Run the arazzo respect tests with your creadentials

• GET /websites/{id}/session-data/properties::

  • response
    • example
    • schema

• GET /websites/{id}/sessions/:session_id/properties::

  • response
    • example
    • schema

• GET /websites/{id}/event-data/properties::

  • response
    • example
    • schema

• POST /reports/retention::

  • response
    • example
    • schema

• POST /reports/attribution::

  • response
    • example
    • schema

• POST /reports/revenue::

  • response
    • example
    • schema

• POST /reports/utm::

  • response
    • example
    • schema

• POST /pixels::

  • response
    • example
    • schema

• POST /pixels/{id}::

  • response
    • example
    • schema

• POST /links::

  • response
    • example
    • schema

• POST /links/{id}::

  • response
    • example
    • schema

• POST /teams/{id}/users/{id}::
• DELETE /teams/{id}/users/{id}::
• POST /teams/join::
• DELETE /websites/{id}/segments/:cohort_id::
• POST /websites/{id}/segments/:cohort_id::
• GET /websites/{id}/segments/:cohort_id::