{"id":27621817,"url":"https://github.com/imjuniper/umami-api-client","last_synced_at":"2025-04-23T08:04:18.517Z","repository":{"id":57711351,"uuid":"514055488","full_name":"imjuniper/umami-api-client","owner":"imjuniper","description":"🍙 Simple, tiny API client for Umami analytics.","archived":true,"fork":false,"pushed_at":"2025-03-21T16:03:44.000Z","size":946,"stargazers_count":12,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-19T05:26:34.456Z","etag":null,"topics":["analytics","api","hacktoberfest","npm-module","npm-package","umami","umami-analytics"],"latest_commit_sha":null,"homepage":"https://npm.im/umami-api","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imjuniper.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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},"funding":{"github":"jakobbouchard"}},"created_at":"2022-07-14T21:42:22.000Z","updated_at":"2025-03-21T16:03:49.000Z","dependencies_parsed_at":"2023-11-20T21:26:20.750Z","dependency_job_id":"0a491e9c-fe59-4f2c-8550-c97b1ecf0648","html_url":"https://github.com/imjuniper/umami-api-client","commit_stats":{"total_commits":120,"total_committers":3,"mean_commits":40.0,"dds":"0.10833333333333328","last_synced_commit":"d57ae4fdc0ca328f9367ceb9ffa77cd2de298120"},"previous_names":["imjuniper/umami-api-client"],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imjuniper%2Fumami-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imjuniper%2Fumami-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imjuniper%2Fumami-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imjuniper%2Fumami-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imjuniper","download_url":"https://codeload.github.com/imjuniper/umami-api-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250395282,"owners_count":21423400,"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","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","hacktoberfest","npm-module","npm-package","umami","umami-analytics"],"created_at":"2025-04-23T08:04:17.483Z","updated_at":"2025-04-23T08:04:18.510Z","avatar_url":"https://github.com/imjuniper.png","language":"TypeScript","funding_links":["https://github.com/sponsors/jakobbouchard"],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003e [!WARNING]\n\u003e I no longer work in web development and I don't really have the time or interest in maintaining this repository anymore. It has been incompatible with umami for a while and it would take me too much time to update it. However, if anybody is interested in maintaining it, I would gladly transfer the repository and NPM package\n\n# Umami API Client\n\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jakobbouchard/umami-api-client/test.yml?branch=main\u0026label=tests\u0026style=flat-square)\n![npm](https://img.shields.io/npm/v/umami-api?style=flat-square)\n![npm bundle size](https://img.shields.io/bundlephobia/minzip/umami-api?style=flat-square)\n![npm downloads](https://img.shields.io/npm/dt/umami-api?style=flat-square)\n\n🍙 Simple, tiny API client for Umami analytics.\n\n## Installation\n\n```shell\nnpm install umami-api\n```\n\n## Usage\n\n```ts\nimport UmamiAPIClient from \"umami-api\";\n```\n\n### Setting default options\n\nDefault options can be set with the following environment variables:\n\n- `UMAMI_CLIENT_TIMEOUT_MS`: Axios timeout in milliseconds. Default: `2000`.\n- `UMAMI_CLIENT_USER_AGENT`: User agent to use for requests. Default: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:102.0) Gecko/20100101 Firefox/102.0`.\n- `UMAMI_CLIENT_TIME_PERIOD`: Default time period for pageviews, events, etc. Default: `24h`.\n- `UMAMI_CLIENT_TIME_UNIT`: Default time unit for pageviews, events, etc. Default: `hour`.\n- `UMAMI_CLIENT_TIMEZONE`: Default timezone for pageviews, events, etc. Default: `America/Toronto`.\n- `UMAMI_CLIENT_METRIC_TYPE`: Default metric type to get. Default: `url`.\n\n## Example\n\n```ts\nimport UmamiAPIClient from \"umami-api\";\n\nconst umami = new UmamiAPIClient(\"stats.example.com\", \"username\", \"password\");\n\nconst newWebsite = await umami.createWebsite({\n\tdomain: \"test.com\",\n\tname: \"test.com\",\n\tenableShareUrl: false,\n});\n\nconst pageviews = await newWebsite.getPageviews();\nconst metrics = await newWebsite.getMetrics();\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimjuniper%2Fumami-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimjuniper%2Fumami-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimjuniper%2Fumami-api-client/lists"}