https://github.com/jakobbouchard/umami-api-client

🍙 Simple, tiny API client for Umami analytics.
https://github.com/jakobbouchard/umami-api-client

analytics api hacktoberfest npm-module npm-package umami umami-analytics

Last synced: 20 days ago
JSON representation

🍙 Simple, tiny API client for Umami analytics.

• Host: GitHub
• URL: https://github.com/jakobbouchard/umami-api-client
• Owner: jakobbouchard
• License: mit
• Created: 2022-07-14T21:42:22.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T11:27:41.000Z (7 months ago)
• Last Synced: 2024-05-01T17:36:17.678Z (7 months ago)
• Topics: analytics, api, hacktoberfest, npm-module, npm-package, umami, umami-analytics
• Language: TypeScript
• Homepage: https://npm.im/umami-api
• Size: 975 KB
• Stars: 11
• Watchers: 1
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
> [!WARNING]

> 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 (if that's possible?)

# Umami API Client

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jakobbouchard/umami-api-client/test.yml?branch=main&label=tests&style=flat-square)

![npm](https://img.shields.io/npm/v/umami-api?style=flat-square)

![npm bundle size](https://img.shields.io/bundlephobia/minzip/umami-api?style=flat-square)

![npm downloads](https://img.shields.io/npm/dt/umami-api?style=flat-square)

🍙 Simple, tiny API client for Umami analytics.

## Installation

```shell

npm install umami-api

```

## Usage

```ts

import UmamiAPIClient from "umami-api";

```

### Setting default options

Default options can be set with the following environment variables:

- `UMAMI_CLIENT_TIMEOUT_MS`: Axios timeout in milliseconds. Default: `2000`.

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

- `UMAMI_CLIENT_TIME_PERIOD`: Default time period for pageviews, events, etc. Default: `24h`.

- `UMAMI_CLIENT_TIME_UNIT`: Default time unit for pageviews, events, etc. Default: `hour`.

- `UMAMI_CLIENT_TIMEZONE`: Default timezone for pageviews, events, etc. Default: `America/Toronto`.

- `UMAMI_CLIENT_METRIC_TYPE`: Default metric type to get. Default: `url`.

## Example

```ts

import UmamiAPIClient from "umami-api";

const umami = new UmamiAPIClient("stats.example.com", "username", "password");

const newWebsite = await umami.createWebsite({

	domain: "test.com",

	name: "test.com",

	enableShareUrl: false,

});

const pageviews = await newWebsite.getPageviews();

const metrics = await newWebsite.getMetrics();

```