Create a New Website — Betterumami POST /api/websites

Use this endpoint to register a new website and start collecting analytics data. At minimum you must supply a name and a domain. You can optionally assign the website to a team, pre-set a public shareId, or provide your own UUID with id. The endpoint returns the full website object, including the tracking snippet configuration you can embed on your site. POST /api/websites

Request

Headers

string

required

Bearer token. Pass your API key: Authorization: Bearer <api-key>

string

required

Must be application/json.

Body Parameters

string

required

Human-readable display name for the website, e.g. "My Marketing Site". Shown throughout the Betterumami UI.

string

required

The domain this website tracks, e.g. "example.com". Do not include the https:// scheme or a trailing slash.

Custom token for the public share page, e.g. "my-public-dashboard". When omitted or null, public sharing is disabled. Must be unique across all websites.

string | null

UUID of the team to assign this website to. When omitted or null, the website is created as a personal website under your account.

string | null

Supply your own UUID to use as the website ID. When omitted, the server generates a UUID automatically.

Response

200 – Success Returns the full website object for the newly created website.

string

required

UUID of the newly created website.

string

required

Display name of the website.

string | null

required

Domain associated with the website.

Public share token, or null if sharing is disabled.

string | null

required

UUID of the assigned team, or null for personal websites.

string | null

required

UUID of the user who owns the website.

string | null

required

UUID of the user who created the website. Same as userId in most cases.

boolean

required

Whether session recording is active. Defaults to false for new websites.

object

required

Session replay and heatmap recording configuration for this website.

string | null

required

ISO 8601 timestamp of the last analytics reset. null for new websites.

string | null

required

ISO 8601 timestamp when the website was created.

string | null

required

ISO 8601 timestamp when the website was last updated.

string | null

required

ISO 8601 timestamp when the website was deleted, or null for active websites.

object

Embedded owner information.

string

UUID of the owning user.

string

Username of the owning user.

200 Response

{
  "id": "b8d3a1f0-1c2d-4e5f-8a9b-0c1d2e3f4a5b",
  "name": "My Marketing Site",
  "domain": "example.com",
  "shareId": null,
  "teamId": null,
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "recorderEnabled": false,
  "replayConfig": {
    "replayEnabled": false,
    "heatmapEnabled": false,
    "sampleRate": 0,
    "heatmapSampleRate": 0,
    "maskLevel": "strict",
    "blockSelector": "",
    "maxDuration": 0
  },
  "resetAt": null,
  "createdAt": "2024-08-01T12:00:00Z",
  "updatedAt": "2024-08-01T12:00:00Z",
  "deletedAt": null,
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "alice"
  }
}

Code Sample

curl -X POST 'https://api.umami.is/v1/websites' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Marketing Site",
    "domain": "example.com",
    "shareId": null,
    "teamId": null
  }'

Overview

Websites

Stats & Events

Node Client

Create a New Website — Betterumami POST /api/websites

Request

Headers

Body Parameters

Response

Code Sample

​Request

​Headers

​Body Parameters

​Response

​Code Sample

Request

Headers

Body Parameters

Response

Code Sample