Umami

https://docs.umami.is/docs/
Admin
Umami is a privacy-focused, open-source web analytics platform that you can self-host, with no...
Tokens:317,696
Snippets:2,111
Trust Score:9.6
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Run standalone migration

Source: https://docs.umami.is/docs/guides/migrate-v1-v2

Starts the migration script after installation and configuration.

```shell
yarn start
```

--------------------------------

### JavaScript: Get website

Source: https://docs.umami.is/docs/api-reference/get-website

JavaScript fetch example to get a website. Uses async/await and sends an Authorization header with a Bearer token.

```javascript
const response = await fetch('https://api.example.com/api/websites/{websiteId}', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

--------------------------------

### Python requests example for GET /api/websites/{websiteId}/revenue/metrics

Source: https://docs.umami.is/docs/api-reference/get-website-revenue-metrics

Python requests example to fetch revenue metrics. Prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/revenue/metrics?type=country&currency=string',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### JavaScript fetch for GET /api/me/websites

Source: https://docs.umami.is/docs/api-reference/get-my-websites

JavaScript fetch example for GET /api/me/websites. Uses async/await and sends an Authorization header with a Bearer token. The response is parsed as JSON.

```javascript
const response = await fetch('https://api.example.com/api/me/websites', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

--------------------------------

### Initial project setup via SSH

Source: https://docs.umami.is/docs/guides/running-on-forge

Run these commands via SSH to install dependencies, update the database schema, and build the project.

```shell
yarn install
yarn update-db
yarn build

```

--------------------------------

### JavaScript: Get session activity

Source: https://docs.umami.is/docs/api-reference/get-website-session-activity

JavaScript example using fetch to call the GET endpoint. The response is parsed as JSON. Requires the website ID, session ID, start and end timestamps, and an Authorization header with a bearer token.

```javascript
const response = await fetch('https://api.example.com/api/websites/{websiteId}/sessions/{sessionId}/activity?startAt=0&endAt=0', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

--------------------------------

### Python: Get session activity

Source: https://docs.umami.is/docs/api-reference/get-website-session-activity

Python example using the requests library to perform a GET request. The response is printed as JSON. Requires the website ID, session ID, start and end timestamps, and an Authorization header with a bearer token.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/sessions/{sessionId}/activity?startAt=0&endAt=0',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### POST /api/2fa/setup/initiate

Source: https://docs.umami.is/docs/api-reference/initiate-two-factor-setup

This endpoint initiates or replaces the two-factor authentication setup for the current user, returning a QR code and manual setup key.

```APIDOC
## POST /api/2fa/setup/initiate

### Description
Starts or replaces the current user's pending setup and returns a QR code and manual setup key for an authenticator app.

### Method
POST

### Endpoint
/api/2fa/setup/initiate

### Authentication
Bearer token required.

### Request Example
```bash
curl -X POST 'https://api.example.com/api/2fa/setup/initiate' \
  -H 'Authorization: Bearer <token>'
```

### Response
#### Success Response (200)
- **manualKey** (string) - Manual setup key for the authenticator app.
- **qrCodeDataUrl** (string) - QR code data URL for the authenticator app.

#### Response Example
```json
{
  "manualKey": "string",
  "qrCodeDataUrl": "string"
}
```

#### Error Responses
- **400** - Bad request.
- **401** - Unauthorized.
- **404** - Not found.
- **503** - Service unavailable.

#### Error Response Example
```json
{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}
```
```

--------------------------------

### JavaScript example for POST /api/me/api-keys

Source: https://docs.umami.is/docs/api-reference/create-my-api-key

JavaScript fetch example to create an API key. Uses async/await and sends a JSON body.

```javascript
const response = await fetch('https://api.example.com/api/me/api-keys', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>',
  },
  body: JSON.stringify({
  "name": {}
}),
});
const data = await response.json();
```

--------------------------------

### Python Requests Example for Get a Team Member

Source: https://docs.umami.is/docs/api-reference/get-team-user

Python requests example to get a team member. Prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/teams/{teamId}/users/{userId}',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### JavaScript example for POST /api/2fa/setup/confirm

Source: https://docs.umami.is/docs/api-reference/confirm-two-factor-setup

JavaScript example using fetch to confirm two-factor authentication setup. It sends a POST request with the token in the body and parses the JSON response.

```javascript
const response = await fetch('https://api.example.com/api/2fa/setup/confirm', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>',
  },
  body: JSON.stringify({
  "token": "string"
}),
});
const data = await response.json();
```

--------------------------------

### Python Requests Example for GET /api/websites/{websiteId}/annotations/{annotationId}

Source: https://docs.umami.is/docs/api-reference/get-website-annotation

Python requests example to get a website annotation. Prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/annotations/{annotationId}',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Python Requests Example for GET /api/teams/{teamId}

Source: https://docs.umami.is/docs/api-reference/get-team

Python requests example for GET /api/teams/{teamId}. Requires the requests library and a Bearer token.

```python
import requests

response = requests.get(
    'https://api.example.com/api/teams/{teamId}',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Deploy Umami on Koyeb with app init

Source: https://docs.umami.is/docs/guides/running-on-koyeb

Initializes a new Koyeb app and deploys the Umami service using the PostgreSQL Docker image. It maps port 3000 to HTTP, sets the route, and passes the previously created secrets as environment variables.

```shell
koyeb app init umami --docker docker.umami.is/umami-software/umami:postgresql-latest --ports 3000:http --routes /:3000 --env DATABASE_URL=@umami-database-url --env APP_SECRET=@umami-app-secret
```

--------------------------------

### Python Requests Example

Source: https://docs.umami.is/docs/api-reference/get-pixels-charts

Python requests example for the GET /api/pixels/charts endpoint. Sends a GET request with the Authorization header and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/pixels/charts?ids=string',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Python example for POST /api/2fa/setup/confirm

Source: https://docs.umami.is/docs/api-reference/confirm-two-factor-setup

Python example using the requests library to confirm two-factor authentication setup. It sends a POST request with the token in the JSON body and prints the response.

```python
import requests

response = requests.post(
    'https://api.example.com/api/2fa/setup/confirm',
    headers={'Authorization': 'Bearer <token>'},
    json={
  'token': 'string'
},
)
print(response.json())
```

--------------------------------

### Python Requests Example for GET /api/dashboard

Source: https://docs.umami.is/docs/api-reference/get-dashboard

Python requests example for GET /api/dashboard. Sends an Authorization header with a Bearer token and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/dashboard',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Install, build, and lint with pnpm

Source: https://docs.umami.is/docs/contributing

Run these commands to install dependencies, build the project, and run the linter. The project must build and lint cleanly before submitting a pull request.

```bash
pnpm install
pnpm build
pnpm lint

```

--------------------------------

### Python Requests Example for Get Custom Event Counts Over Time

Source: https://docs.umami.is/docs/api-reference/get-website-event-series

Python requests example for the GET /api/websites/{websiteId}/events/series endpoint. Prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/events/series?startAt=0&endAt=0&timezone=string',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### JavaScript fetch example for POST /api/boards

Source: https://docs.umami.is/docs/api-reference/create-board

JavaScript fetch example to create a board. Uses async/await and sends a JSON body with the board configuration.

```javascript
const response = await fetch('https://api.example.com/api/boards', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>',
  },
  body: JSON.stringify({
  "description": "string",
  "name": "string",
  "parameters": {
    "linkId": "123e4567-e89b-12d3-a456-426614174000",
    "pixelId": "123e4567-e89b-12d3-a456-426614174000",
    "websiteId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "teamId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "string",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}),
});
const data = await response.json();
```

--------------------------------

### Python Requests Example for GET /api/boards/{boardId}

Source: https://docs.umami.is/docs/api-reference/get-board

Python example using the requests library. Sends a GET request with an authorization header and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/boards/{boardId}',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Install Umami with bundled PostgreSQL

Source: https://docs.umami.is/docs/guides/running-on-helmforge

Creates a namespace and installs the Umami chart with bundled PostgreSQL. The default login credentials are username admin and password umami.

```shell
kubectl create namespace umami

helm install umami helmforge/umami \
  --namespace umami
```

--------------------------------

### Python Requests Example for Get Website Saved Goal Stats

Source: https://docs.umami.is/docs/api-reference/get-website-saved-goal-stats

Python requests example for the endpoint. Sends a GET request with a bearer token and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/goals/{goalId}/stats?startAt=0&endAt=0',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Set up Neon Postgres with Neon CLI and DATABASE_URL

Source: https://docs.umami.is/docs/guides/running-on-neon

Commands and configuration for setting up a Neon Postgres database for Umami. Use the Neon CLI to create a project and get a pooled connection string, then add the DATABASE_URL to your .env file with the required ?pgbouncer=true&connect_timeout=10 parameters. Finally, run the build-db and update-db scripts to check the connection and update the schema.

```bash
npx neonctl projects create
```

```bash
npx neonctl connection-string --project-id <project-id> --pooled
```

```text
DATABASE_URL=postgres://user:passwd@endpoint-pooler.region.aws.neon.tech/neondb?pgbouncer=true&connect_timeout=10
```

```bash
yarn run build-db && yarn run update-db
```

--------------------------------

### Python Requests Example for GET /api/websites/{websiteId}/session-data-pivot

Source: https://docs.umami.is/docs/api-reference/get-session-data-pivot

Python requests example for the session-data-pivot endpoint. Sends a GET request with a bearer token and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/session-data-pivot?startAt=0&endAt=0&propertyName=string',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### 200 response example for GET /api/links/charts

Source: https://docs.umami.is/docs/api-reference/get-links-charts

Example of a successful response with an empty data object.

```json
{
  "data": {}
}
```

--------------------------------

### umami.init

Source: https://docs.umami.is/docs/api/node-client

Initializes the Umami node client with the required configuration.

```APIDOC
## [NODE] umami.init

### Description
Initializes the Umami node client with your website ID and host URL.

### Method
init

### Parameters
- **websiteId** (string) - Required - Your website ID.
- **hostUrl** (string) - Required - URL to your Umami instance.

### Request Example
```js
umami.init({
  websiteId: '50429a93-8479-4073-be80-d5d29c09c2ec',
  hostUrl: 'https://umami.mywebsite.com'
});
```

### Response
No response is returned.

```

--------------------------------

### Python: Get website

Source: https://docs.umami.is/docs/api-reference/get-website

Python requests example to get a website. Sends a GET request with an Authorization header and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Start Umami application

Source: https://docs.umami.is/docs/install

Starts the application, which by default listens on http://localhost:3000. You may need to proxy requests or change the port.

```shell
pnpm start
```

--------------------------------

### Python Requests Example for Get Website Saved Funnel Stats

Source: https://docs.umami.is/docs/api-reference/get-website-saved-funnel-stats

Python example using the requests library to call the endpoint. It sends a GET request with an Authorization header and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/funnels/{funnelId}/stats?startAt=0&endAt=0',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### JavaScript fetch to create a website

Source: https://docs.umami.is/docs/api-reference/create-website

JavaScript fetch example to create a website. Uses async/await and sends a JSON body.

```javascript
const response = await fetch('https://api.example.com/api/websites', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>',
  },
  body: JSON.stringify({
  "domain": "string",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "shareId": "string",
  "teamId": "123e4567-e89b-12d3-a456-426614174000"
}),
});
const data = await response.json();
```

--------------------------------

### Python Request for GET /api/teams

Source: https://docs.umami.is/docs/api-reference/get-teams

Python requests example for GET /api/teams. Sends a GET request with an Authorization header and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/teams',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Initialize and track with @umami/node

Source: https://docs.umami.is/docs/api/node-client

Import and initialize the Umami Node client with your website ID and host URL, then send a page view event. For Umami Cloud, use https://cloud.umami.is as the host URL.

```javascript
import umami from '@umami/node';

umami.init({
  websiteId: '50429a93-8479-4073-be80-d5d29c09c2ec', // Your website id
  hostUrl: 'https://umami.mywebsite.com', // URL to your Umami instance
});

umami.track({ url: '/home' });
```

--------------------------------

### Import and use the Umami API client

Source: https://docs.umami.is/docs/api/api-client

Import the configured api-client and query using available class methods. The example calls getWebsites() and destructures the response into ok, data, status, and error.

```js
import { getClient } from '@umami/api-client';

const client = getClient();

const { ok, data, status, error } = await client.getWebsites();
```

--------------------------------

### Python Requests for GET /api/links

Source: https://docs.umami.is/docs/api-reference/get-links

Python requests example for GET /api/links. Sends a GET request with a Bearer token and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/links',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### 200 success response for initiate 2FA setup

Source: https://docs.umami.is/docs/api-reference/initiate-two-factor-setup

Successful response containing the manual key and QR code data URL for the authenticator app.

```json
{
  "manualKey": "string",
  "qrCodeDataUrl": "string"
}
```

--------------------------------

### Python requests example

Source: https://docs.umami.is/docs/api-reference/get-website-performance-metrics

Python requests example to get performance metrics. Prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/performance/metrics?startAt=0&endAt=0&type=path',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Install @umami/node with npm

Source: https://docs.umami.is/docs/api/node-client

Install the Umami Node client package using npm.

```shell
npm install @umami/node
```

--------------------------------

### Python requests for GET /api/me/websites

Source: https://docs.umami.is/docs/api-reference/get-my-websites

Python requests example for GET /api/me/websites. Sends a GET request with a Bearer token in the headers and prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/me/websites',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Python Requests Example for GET /api/boards

Source: https://docs.umami.is/docs/api-reference/get-boards

Python requests example to fetch boards. Prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/boards',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### JavaScript example for POST /api/boards/{boardId}/shares

Source: https://docs.umami.is/docs/api-reference/create-board-share

JavaScript example using fetch to create a share. Replace `{boardId}` and `<token>` as needed.

```javascript
const response = await fetch('https://api.example.com/api/boards/{boardId}/shares', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>',
  },
  body: JSON.stringify({
  "name": "string",
  "parameters": null
}),
});
const data = await response.json();
```

--------------------------------

### Python example for POST /api/me/api-keys

Source: https://docs.umami.is/docs/api-reference/create-my-api-key

Python requests example to create an API key. Prints the JSON response.

```python
import requests

response = requests.post(
    'https://api.example.com/api/me/api-keys',
    headers={'Authorization': 'Bearer <token>'},
    json={
  'name': {}
},
)
print(response.json())
```

--------------------------------

### Python Requests Example for Get Website Heatmaps

Source: https://docs.umami.is/docs/api-reference/get-website-heatmaps

Python requests example for the heatmaps endpoint. Prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/heatmaps?startAt=0&endAt=0',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Python requests example

Source: https://docs.umami.is/docs/api-reference/get-website-funnel

Python requests example to get a website funnel. Requires the requests library and a bearer token.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/funnels/{funnelId}',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### cURL example for POST /api/me/api-keys

Source: https://docs.umami.is/docs/api-reference/create-my-api-key

cURL command to create an API key. Requires an authentication token.

```bash
curl -X POST 'https://api.example.com/api/me/api-keys' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": {}
}'
```

--------------------------------

### cURL Request for GET /api/teams/{teamId}

Source: https://docs.umami.is/docs/api-reference/get-team

cURL example for GET /api/teams/{teamId}. Requires a Bearer token for authorization.

```bash
curl -X GET 'https://api.example.com/api/teams/{teamId}' \
  -H 'Authorization: Bearer <token>'
```

--------------------------------

### JavaScript example

Source: https://docs.umami.is/docs/api-reference/save-website-replay

JavaScript fetch example to save or unsave a replay. Uses async/await and parses the JSON response.

```javascript
const response = await fetch('https://api.example.com/api/websites/{websiteId}/replays/saved/{replayId}', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>',
  },
  body: JSON.stringify({
  "isSaved": true,
  "name": "string"
}),
});
const data = await response.json();
```

--------------------------------

### Python requests example for GET /api/websites/{websiteId}/event-data-pivot/date-series

Source: https://docs.umami.is/docs/api-reference/get-event-data-date-series

Python requests example for the date-series endpoint. Prints the JSON response.

```python
import requests

response = requests.get(
    'https://api.example.com/api/websites/{websiteId}/event-data-pivot/date-series?startAt=0&endAt=0&eventName=string&propertyName=string',
    headers={'Authorization': 'Bearer <token>'},
)
print(response.json())
```

--------------------------------

### Start Umami with Docker Compose

Source: https://docs.umami.is/docs/install

Builds and starts the Docker container with a PostgreSQL database. The app runs on http://localhost:3000 with default credentials admin/umami.

```shell
docker compose up -d
```

--------------------------------

### JavaScript example for POST /api/links/{linkId}/shares

Source: https://docs.umami.is/docs/api-reference/create-link-share

JavaScript example using fetch to create a share. Replace `{linkId}` with the actual link ID and provide a valid bearer token.

```javascript
const response = await fetch('https://api.example.com/api/links/{linkId}/shares', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>',
  },
  body: JSON.stringify({
  "name": "string",
  "parameters": null
}),
});
const data = await response.json();
```

--------------------------------

### JavaScript fetch example for POST /api/pixels

Source: https://docs.umami.is/docs/api-reference/create-pixel

JavaScript fetch example to create a tracking pixel. Uses async/await and sends a JSON body with a bearer token.

```javascript
const response = await fetch('https://api.example.com/api/pixels', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>',
  },
  body: JSON.stringify({
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "slug": "string",
  "teamId": "string"
}),
});
const data = await response.json();
```
Tokens:
Raw