umami-software-umami

Namespace

umami-software-umami

Description:

  • Discover Umami, the fast and privacy-centric analytics tool! It's the perfect simple alternative to Google Analytics. Experience seamless data insights without compromising user privacy.

Author:
Copyright:
  • 2025 Eyevinn Technology AB

Methods

(async, static) createUmamiSoftwareUmamiInstance(context, body) → {UmamiSoftwareUmami}

Description:

  • Create a new Umami instance

Example
import { Context } from '@osaas/client-core';
import { createUmamiSoftwareUmamiInstance } from '@osaas/client-services';

const ctx = new Context();
const body: UmamiSoftwareUmamiConfig = { name: 'myinstance', ... };
const instance = await createUmamiSoftwareUmamiInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body UmamiSoftwareUmamiConfig

Service instance configuration
Returns:
  • Service instance
Type
UmamiSoftwareUmami

(async, static) getUmamiSoftwareUmamiInstance(context, name) → {UmamiSoftwareUmami}

Description:

  • Get a Umami instance

Example
import { Context } from '@osaas/client-core';
import { getUmamiSoftwareUmamiInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getUmamiSoftwareUmamiInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the umami to be retrieved
Returns:
  • Service instance
Type
UmamiSoftwareUmami

(async, static) removeUmamiSoftwareUmamiInstance(context, name)

Description:

  • Remove a Umami instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the umami to be removed