{"id":15373858,"url":"https://github.com/boly38/action-umami-report","last_synced_at":"2025-08-02T04:34:47.205Z","repository":{"id":41487538,"uuid":"509767321","full_name":"boly38/action-umami-report","owner":"boly38","description":"github action that use umami-software/umami API to generate a report","archived":false,"fork":false,"pushed_at":"2025-06-11T22:11:48.000Z","size":5210,"stargazers_count":13,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-20T04:56:00.360Z","etag":null,"topics":["actions","anaytics","github-actions","hacktoberfest","umami","umami-analytics"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/boly38.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}},"created_at":"2022-07-02T13:48:18.000Z","updated_at":"2025-05-24T04:58:39.000Z","dependencies_parsed_at":"2024-11-15T22:29:00.418Z","dependency_job_id":"8f1b2cb7-dbf3-4de2-bf36-2b962a2372eb","html_url":"https://github.com/boly38/action-umami-report","commit_stats":{"total_commits":48,"total_committers":2,"mean_commits":24.0,"dds":0.0625,"last_synced_commit":"3b3b7604edd2a340ef1b47983408e3d95c245db2"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/boly38/action-umami-report","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boly38%2Faction-umami-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boly38%2Faction-umami-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boly38%2Faction-umami-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boly38%2Faction-umami-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boly38","download_url":"https://codeload.github.com/boly38/action-umami-report/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boly38%2Faction-umami-report/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268334630,"owners_count":24233794,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["actions","anaytics","github-actions","hacktoberfest","umami","umami-analytics"],"created_at":"2024-10-01T13:56:34.735Z","updated_at":"2025-08-02T04:34:47.148Z","avatar_url":"https://github.com/boly38.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# action-umami-report\r\n\r\nThis [action](./action.yml) generates periodic umami reports into a given file, and action outputs.\r\n\r\nAccepted periods are: 1h, 1d, 1w, 1m.\r\n\r\n## Inputs\r\n\r\n| input name             | required | description                             |\r\n|------------------------|----------|-----------------------------------------|\r\n| `umami-cloud-api-key`  | (1)      | Umami Cloud API key .                   |\r\n| `umami-server`         | (2)      | Umami server instance .                 |\r\n| `umami-user`           | (2)      | Umami API user. Default `\"admin\"`.      | \r\n| `umami-password`       | (2)      | Umami API password.                     | \r\n| `umami-site-domain`    | no       | Umami site domain name (*).             | \r\n| `umami-report-file`    | no       | Umami report file to generate.          | \r\n| `umami-report-content` | no       | Report content to generate (*).         | \r\n| `umami-period`         | no       | (main) Report data/analysis period (*). | \r\n| `umami-unit`           | no       | (main) Report interval unit (*).        | \r\n| `umami-tz`             | no       | (main) Report date time timezone (*).   | \r\n\r\nlegend(1)(2):\r\n\r\n- (1) `umami-cloud-api-key` is required for Umami [CLOUD](https://cloud.umami.is/) mode ([create yours](https://cloud.umami.is/api-keys))\r\n- (2) `umami-server` `umami-user` `umami-password` is required for Umami Hosted mode\r\n- (2) [Umami API](https://umami.is/docs/api) login expected to be available at `\u003cumami-server\u003e/api/auth/login`.\r\n\r\n  legend*:\r\n- `umami-site-domain` is the target analysis domain name, example `\"www.mysite.com\"` (select first domain by default ).\r\n- `umami-report-content` default is `pageviews|events|sessions|urls` (stats is always reported).\r\n- `umami-period` default is `24h` (means 24 hours). But you can switch it to `24h`/`7d`/`1w`/`31d`/`1m`.\r\n- `umami-unit` default is `hour`. But you can switch it to `day` depend on the period you choose.\r\n- `umami-tz` default is `Europe/Paris`. But you can switch it to another timezone supported by Umami API (ex.\r\n  `America/Los_Angeles`).\r\n\r\n## Action outputs\r\n\r\nThis action produces some \"action results\" where an action result is a `resultName`, and a `resultValue`.\r\n\r\nEach action result is available\r\nas [output parameter](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter) :\r\nto use in following `step` or`job`\r\n\r\n| resultName           | resultValue        | description                     |\r\n|----------------------|--------------------|---------------------------------|\r\n| `pageViews`          | integer            | number of pageView in last 24h  |\r\n| `umamiOneLineReport` | string             | short summary of domain stats   | \r\n| `umamiReport`        | multi-lines string | detailed report of domain stats | \r\n| `umamiReportLength`  | int                | v1.2, detailed report length    | \r\n\r\n## Action generated file\r\n\r\nWhen an `umami-report-file` is set, the target file is written in `./umami/\u003cumami-report-file\u003e`.\r\n\r\n## Example usage\r\n\r\n```yaml\r\njobs:\r\n  umamiReport:\r\n    name: umami report example\r\n    runs-on: ubuntu-latest\r\n\r\n    steps:\r\n      - name: Create Umami report\r\n        id: umamiReport\r\n        uses: boly38/action-umami-report@umami-server-2.17.0\r\n        with:\r\n          umami-server: ${{secrets.UMAMI_SERVER}}\r\n          umami-user: ${{secrets.UMAMI_USERNAME}}\r\n          umami-password: ${{secrets.UMAMI_PASSWORD}}\r\n          umami-site-domain: ${{secrets.UMAMI_SITE_DOMAIN}}\r\n          umami-report-file: 'umamiReport.md'\r\n\r\n      - name: Send report to discord if pageViews is positive\r\n        if: steps.umamiReportStep.outputs.pageViews != '0'\r\n        uses: tsickert/discord-webhook@v7.0.0\r\n        with:\r\n          webhook-url: ${{ secrets.UMAMI_TO_DISCORD_WEBHOOK_URL }}\r\n          username: \"Umami report\"\r\n          content: \"${{ steps.umamiReportStep.outputs.umamiOneLineReport }}\"\r\n          filename: \"${{ steps.umamiReportStep.outputs.umamiReportFile }}\"\r\n          # avatar-url: ..set user logo\r\n```\r\n\r\ncf. working sample: cf. [(full) daily yml](.github/workflows/cron_daily_umami_report.yml) or [(min) weekly yml](.github/workflows/cron_weekly_umami_report.yml)\r\n\r\n**TIP**: if your umami server version is not compatible with current GithubActions, you could change\r\n`umami-server-2.17.0` keyword by one of\r\nthe [current repository tags](https://github.com/boly38/action-umami-report/tags) with `umami-server-x.y` format.\r\n\r\n# See also\r\n\r\n## Umami\r\n\r\nUmami server : [API](https://umami.is/docs/api) - [source](https://github.com/umami-software/umami)\r\n\r\nUmami API clients:\r\n\r\n- boly38 JS [umami-api-client](https://github.com/boly38/umami-api-client)\r\n  - Import: `import UmamiClient from 'umami-api-client'`\r\n- (archived) jakobbouchard TS/JS [umami-api-client](https://github.com/jakobbouchard/umami-api-client)\r\n  - Import: `import UmamiApiClient from 'umami-api'`\r\n\r\n\r\n## possible next step\r\n\r\n- send the report [by email](https://github.com/marketplace?type=actions\u0026query=mail+),\r\n  on [discord](https://github.com/marketplace?type=actions\u0026query=discord+), etc..\r\n\r\n### Services or activated bots\r\n\r\n| ![CI/CD](https://github.com/boly38/action-umami-report/workflows/main_ci_and_package_action/badge.svg) | [![Automated Release Notes by gren](https://img.shields.io/badge/%F0%9F%A4%96-release%20notes-00B2EE.svg)](https://github-tools.github.io/github-release-notes/) | [\u003cimg src=\"https://cdn.icon-icons.com/icons2/2148/PNG/512/houndci_icon_132320.png\" width=\"40\"\u003e](https://houndci.com/) | [\u003cimg src=\"https://codetheweb.blog/assets/img/posts/github-pages-free-hosting/cover.png\" width=\"100\"\u003e](https://boly38.github.io/action-umami-report/) |\r\n|------------------------------------------------------------------------------------------------| ---- | ---- | ---- |\r\n\r\n- Github actions : continuous tests + coverage using [c8](https://www.npmjs.com/package/c8) reported on github pages [website](https://boly38.github.io/action-umami-report/)\r\n- Github security checks activated\r\n- [Houndci](https://houndci.com/) : JavaScript  automated review (configured by `.hound.yml`)\r\n- [gren](https://github.com/github-tools/github-release-notes) : [Release notes](https://github.com/boly38/action-umami-report/releases) automation\r\n- Github pages [website](https://boly38.github.io/action-umami-report/) hosts some metrics for the main branch of this project: [code coverage](https://boly38.github.io/action-umami-report/)\r\n\r\n\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboly38%2Faction-umami-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboly38%2Faction-umami-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboly38%2Faction-umami-report/lists"}