https://github.com/ceviixx/umami-api-docs

API docs and automated tests for Umami Analytics. Powers the GitHub Pages site with up-to-date documentation and response checks.
https://github.com/ceviixx/umami-api-docs

analytics api api-documentation api-testing automation category-docs developer-tools github-pages monitoring openapi redocly rest-api swagger testing umami

Last synced: 6 days ago
JSON representation

API docs and automated tests for Umami Analytics. Powers the GitHub Pages site with up-to-date documentation and response checks.

• Host: GitHub
• URL: https://github.com/ceviixx/umami-api-docs
• Owner: ceviixx
• Created: 2025-05-20T10:46:35.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-10-18T12:36:27.000Z (4 months ago)
• Last Synced: 2025-10-18T19:01:21.911Z (3 months ago)
• Topics: analytics, api, api-documentation, api-testing, automation, category-docs, developer-tools, github-pages, monitoring, openapi, redocly, rest-api, swagger, testing, umami
• Homepage:
• Size: 95.7 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

          
# umami API Docs

API documentation for [Umami Analytics](https://umami.is/).  

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

[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-0A0?style=flat-square)](https://ceviixx.github.io/umami-api-docs/)

\

\

[![Umami version](https://img.shields.io/badge/Umami-3.0.0-6f42c1?style=flat-square)](https://umami.is/)

![Pages deployed](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.github.com%2Frepos%2Fceviixx%2Fumami-api-docs%2Factions%2Fworkflows%2Fdeploy-docs.yml%2Fruns%3Fper_page%3D1&query=$.workflow_runs[0].updated_at&label=Pages%20deployed&color=6f42c1&style=flat-square&cacheSeconds=300)

### Script usage

- `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

---

### Endpoints not complete

- GET [/websites/{id}/session-data/properties:](openapi/openapi.yaml#L1175):

  - response

    - example

    - schema

- GET [/websites/{id}/sessions/:session_id/properties:](openapi/openapi.yaml#L1322):

  - response

    - example

    - schema

- GET [/websites/{id}/event-data/properties:](openapi/openapi.yaml#L1549):

  - response

    - example

    - schema

- POST [/reports/retention:](openapi/openapi.yaml#L1862):

  - response

    - example

    - schema

- POST [/reports/attribution:](openapi/openapi.yaml#L1917):

  - response

    - example

    - schema

- POST [/reports/revenue:](openapi/openapi.yaml#L1984):

  - response

    - example

    - schema

- POST [/reports/utm:](openapi/openapi.yaml#L2043):

  - response

    - example

    - schema

- POST [/pixels:](openapi/openapi.yaml#L2098):

  - response

    - example

    - schema

- POST [/pixels/{id}:](openapi/openapi.yaml#L2201):

  - response

    - example

    - schema

- POST [/links:](openapi/openapi.yaml#L2332):

  - response

    - example

    - schema

- POST [/links/{id}:](openapi/openapi.yaml#L2445):

  - response

    - example

    - schema

--- 

### Only endpoint setup but config missing

- POST [/teams/{id}/users/{id}:](openapi/openapi.yaml#L3696):

- DELETE [/teams/{id}/users/{id}:](openapi/openapi.yaml#L3696):

- POST [/teams/join:](openapi/openapi.yaml#L3683):

- DELETE [/websites/{id}/segments/:cohort_id:](openapi/openapi.yaml#L2403):

- POST [/websites/{id}/segments/:cohort_id:](openapi/openapi.yaml#L2403):

- GET [/websites/{id}/segments/:cohort_id:](openapi/openapi.yaml#L2403):