{"id":28316851,"url":"https://github.com/ceviixx/umami-api-docs","last_synced_at":"2026-01-26T02:36:59.869Z","repository":{"id":294464618,"uuid":"986940893","full_name":"ceviixx/umami-api-docs","owner":"ceviixx","description":"API docs and automated tests for Umami Analytics. Powers the GitHub Pages site with up-to-date documentation and response checks.","archived":false,"fork":false,"pushed_at":"2025-10-18T12:36:27.000Z","size":98,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-18T19:01:21.911Z","etag":null,"topics":["analytics","api","api-documentation","api-testing","automation","category-docs","developer-tools","github-pages","monitoring","openapi","redocly","rest-api","swagger","testing","umami"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ceviixx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-20T10:46:35.000Z","updated_at":"2025-10-18T12:35:06.000Z","dependencies_parsed_at":"2025-06-19T21:23:35.426Z","dependency_job_id":"7dde5cdf-ecd2-4fc1-a24a-2d810c9ec70d","html_url":"https://github.com/ceviixx/umami-api-docs","commit_stats":null,"previous_names":["ceviixx/umami-api-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ceviixx/umami-api-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceviixx%2Fumami-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceviixx%2Fumami-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceviixx%2Fumami-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceviixx%2Fumami-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ceviixx","download_url":"https://codeload.github.com/ceviixx/umami-api-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceviixx%2Fumami-api-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28765189,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T02:25:41.078Z","status":"ssl_error","status_checked_at":"2026-01-26T02:24:28.809Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","api","api-documentation","api-testing","automation","category-docs","developer-tools","github-pages","monitoring","openapi","redocly","rest-api","swagger","testing","umami"],"created_at":"2025-05-25T03:08:22.214Z","updated_at":"2026-01-26T02:36:59.864Z","avatar_url":"https://github.com/ceviixx.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# umami API Docs\n\nAPI documentation for [Umami Analytics](https://umami.is/).  \nThis repo maintains an OpenAPI spec that tracks changes in Umami and publishes documentation via GitHub Pages (Redocly).\n\n[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-0A0?style=flat-square)](https://ceviixx.github.io/umami-api-docs/)\n\\\n\\\n[![Umami version](https://img.shields.io/badge/Umami-3.0.0-6f42c1?style=flat-square)](https://umami.is/)\n![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\u0026query=$.workflow_runs[0].updated_at\u0026label=Pages%20deployed\u0026color=6f42c1\u0026style=flat-square\u0026cacheSeconds=300)\n\n\n\n### Script usage\n- `npm run start` \n  Start live server\n- `npm run build`\n  Build bundle.yaml in dist\n- `npm run build:docs`\n  Create the html page based on template\n- `npm run test`\n  Run lint test and check openapi\n- `npm run arazzo:build`\n  Generate arazzo test file\n- `npm run arazzo:test -- --input api-key={YOUR_API_KEY}`\n  Run the arazzo respect tests with your creadentials\n\n\n\n---\n\n### Endpoints not complete\n\n- GET [/websites/{id}/session-data/properties:](openapi/openapi.yaml#L1175):\n  - response\n    - example\n    - schema\n\n- GET [/websites/{id}/sessions/:session_id/properties:](openapi/openapi.yaml#L1322):\n  - response\n    - example\n    - schema\n\n- GET [/websites/{id}/event-data/properties:](openapi/openapi.yaml#L1549):\n  - response\n    - example\n    - schema\n\n- POST [/reports/retention:](openapi/openapi.yaml#L1862):\n  - response\n    - example\n    - schema\n\n- POST [/reports/attribution:](openapi/openapi.yaml#L1917):\n  - response\n    - example\n    - schema\n\n- POST [/reports/revenue:](openapi/openapi.yaml#L1984):\n  - response\n    - example\n    - schema\n\n- POST [/reports/utm:](openapi/openapi.yaml#L2043):\n  - response\n    - example\n    - schema\n\n- POST [/pixels:](openapi/openapi.yaml#L2098):\n  - response\n    - example\n    - schema\n\n- POST [/pixels/{id}:](openapi/openapi.yaml#L2201):\n  - response\n    - example\n    - schema\n\n- POST [/links:](openapi/openapi.yaml#L2332):\n  - response\n    - example\n    - schema\n\n- POST [/links/{id}:](openapi/openapi.yaml#L2445):\n  - response\n    - example\n    - schema\n\n\n--- \n\n\n### Only endpoint setup but config missing\n\n- POST [/teams/{id}/users/{id}:](openapi/openapi.yaml#L3696):\n- DELETE [/teams/{id}/users/{id}:](openapi/openapi.yaml#L3696):\n- POST [/teams/join:](openapi/openapi.yaml#L3683):\n- DELETE [/websites/{id}/segments/:cohort_id:](openapi/openapi.yaml#L2403):\n- POST [/websites/{id}/segments/:cohort_id:](openapi/openapi.yaml#L2403):\n- GET [/websites/{id}/segments/:cohort_id:](openapi/openapi.yaml#L2403):\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceviixx%2Fumami-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fceviixx%2Fumami-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceviixx%2Fumami-api-docs/lists"}