Websites & Users

Manage websites and users through the Umami API

Management endpoints require an account with sufficient privileges (admin for users). None of these responses are cached.

Websites

php

Umami::websites();                 // Collection<WebsiteData>
Umami::website('site-uuid');       // WebsiteData

Umami::createWebsite([
    'name' => 'My site',
    'domain' => 'example.com',
]);                                // WebsiteData

Umami::updateWebsite('site-uuid', ['name' => 'Renamed']); // WebsiteData
Umami::deleteWebsite('site-uuid'); // bool

Users

php

Umami::users();              // Collection<UserData>
Umami::user('user-id');      // UserData

Umami::createUser([
    'username' => 'jane',
    'password' => 'secret',
    'role' => 'user',
]);                          // UserData

Umami::updateUser('user-id', ['username' => 'jane.doe']); // UserData
Umami::deleteUser('user-id'); // bool

Escape hatch

For any endpoint not wrapped by a dedicated method, call get() directly:

php

Umami::get('event-data/fields', ['websiteId' => 'site-uuid']);

Reporting

Stats, active visitors, pageviews, and metrics

TypeScript DTOs

Generate front-end interfaces from the package DTOs