# Umami

> Read your website traffic from Umami: visitors, page views, top pages and referrers, and who's on the site now, for reports and alerts. Start a workflow when traffic spikes.

App · 9 actions. Web page: https://docs.lodol.com/docs/integrations/umami

## Actions

### Add website

Add a website to Umami, and get the tracking code to put on its pages.

**Inputs**

- Name (`name`, text, required): What to call it in Umami.
- Domain (`domain`, text, required): The site's domain, such as example.com.

**Outputs**

- `created_at` (text): When it was added (ISO 8601)
- `domain` (text): Its domain
- `id` (text): The website's ID
- `link` (text): A link to its dashboard
- `name` (text): Its name in Umami
- `tracking_code` (text): The script tag to put on the site's pages

**Example output**

```json
{
  "created_at": "2026-01-12T09:00:00.000Z",
  "domain": "example.com",
  "id": "4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c",
  "link": "https://cloud.umami.is/websites/4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c",
  "name": "Example",
  "tracking_code": "<script defer src=\"https://cloud.umami.is/script.js\" data-website-id=\"4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c\"></script>"
}
```

### Delete website

Delete a website from Umami, with all its traffic data.

**Inputs**

- Website (`website`, text, required): The website.

**Outputs**

- `deleted` (true/false): True once deleted
- `id` (text): The website's ID

**Example output**

```json
{
  "deleted": true,
  "id": "4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c"
}
```

### Get active visitors

Get how many people are on a website now, counted over the last 5 minutes.

**Inputs**

- Website (`website`, text, required): The website.

**Outputs**

- `visitors` (number): People on the site now
- `website_id` (text): The website's ID

**Example output**

```json
{
  "visitors": 12,
  "website_id": "4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c"
}
```

### Get current user

Who the connection signs in to Umami as.

**Inputs**: None.

**Outputs**

- `cloud` (true/false): True on Umami Cloud
- `id` (text): The user's ID
- `role` (text): Their role
- `username` (text): Their username

**Example output**

```json
{
  "cloud": true,
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "role": "user",
  "username": "ada"
}
```

### Get page views over time

Get a website's page views and visits for a period, hour by hour, day by day or by month.

**Inputs**

- Website (`website`, text, required): The website.
- Period (`period`, text): Which days to read. Defaults to today. One of: `today`, `yesterday`, `last_7_days` (Last 7 days), `last_30_days` (Last 30 days), `this_month` (This month), `last_month` (Last month), `custom` (From and to dates). Default: `today`.
- From (`start_date`, date): With 'From and to dates', the first day.
- To (`end_date`, date): With 'From and to dates', the last day.
- By (`unit`, text): Hour by hour, day by day or by month. Defaults to day. One of: `hour`, `day`, `month`. Default: `day`.
- Time zone (`time_zone`, text): The time zone the days are in, such as Europe/London. Defaults to UTC.

**Outputs**

- `count` (number): How many rows
- `from` (text): The first day read (YYYY-MM-DD)
- `points` (list): One row per hour, day or month
- `to` (text): The last day read
- `unit` (text): hour, day or month
- `website_id` (text): The website's ID

**Example output**

```json
{
  "count": 1,
  "from": "2026-10-27",
  "points": [
    {
      "pageviews": 871,
      "time": "2026-10-27 00:00:00",
      "visits": 334
    }
  ],
  "to": "2026-10-28",
  "unit": "day",
  "website_id": "4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c"
}
```

### Get stats

Get a website's visitors, visits, page views, bounce rate and average visit for a period, with the period before it.

**Inputs**

- Website (`website`, text, required): The website.
- Period (`period`, text): Which days to read. Defaults to today. One of: `today`, `yesterday`, `last_7_days` (Last 7 days), `last_30_days` (Last 30 days), `this_month` (This month), `last_month` (Last month), `custom` (From and to dates). Default: `today`.
- From (`start_date`, date): With 'From and to dates', the first day.
- To (`end_date`, date): With 'From and to dates', the last day.
- Time zone (`time_zone`, text): The time zone the days are in, such as Europe/London. Defaults to UTC.

**Outputs**

- `average_visit_seconds` (number): How long a visit lasted on average, in seconds
- `bounce_rate` (number): Visits that saw one page, as a percentage
- `from` (text): The first day read (YYYY-MM-DD)
- `pageviews` (number): Page views
- `previous_pageviews` (number): Page views in the period before
- `previous_visitors` (number): Unique visitors in the period before
- `previous_visits` (number): Visits in the period before
- `to` (text): The last day read
- `visitors` (number): Unique visitors
- `visits` (number): Visits
- `website_id` (text): The website's ID

**Example output**

```json
{
  "average_visit_seconds": 96,
  "bounce_rate": 41.3,
  "from": "2026-10-22",
  "pageviews": 6120,
  "previous_pageviews": 5874,
  "previous_visitors": 1702,
  "previous_visits": 2140,
  "to": "2026-10-28",
  "visitors": 1840,
  "visits": 2315,
  "website_id": "4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c"
}
```

### Get top list

Get a website's top pages, referrers, countries, browsers, devices or events for a period.

**Inputs**

- Website (`website`, text, required): The website.
- List (`metric`, text): Which top list. Defaults to pages. One of: `path` (Pages), `referrer` (Referrers), `country` (Countries), `browser` (Browsers), `os` (Operating systems), `device` (Devices), `event` (Events), `title` (Page titles), `utmSource` (UTM sources). Default: `path`.
- Period (`period`, text): Which days to read. Defaults to today. One of: `today`, `yesterday`, `last_7_days` (Last 7 days), `last_30_days` (Last 30 days), `this_month` (This month), `last_month` (Last month), `custom` (From and to dates). Default: `today`.
- From (`start_date`, date): With 'From and to dates', the first day.
- To (`end_date`, date): With 'From and to dates', the last day.
- Time zone (`time_zone`, text): The time zone the days are in, such as Europe/London. Defaults to UTC.
- How many (`limit`, number): How many to list. Defaults to 10. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `from` (text): The first day read (YYYY-MM-DD)
- `items` (list): The list, most first
- `metric` (text): Which list
- `to` (text): The last day read
- `website_id` (text): The website's ID

**Example output**

```json
{
  "count": 1,
  "from": "2026-10-22",
  "items": [
    {
      "count": 812,
      "value": "/pricing"
    }
  ],
  "metric": "path",
  "to": "2026-10-28",
  "website_id": "4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c"
}
```

### Get website

Get a website's name, domain and dashboard link.

**Inputs**

- Website (`website`, text, required): The website.

**Outputs**

- `created_at` (text): When it was added (ISO 8601)
- `domain` (text): Its domain
- `id` (text): The website's ID
- `link` (text): A link to its dashboard
- `name` (text): Its name in Umami

**Example output**

```json
{
  "created_at": "2026-01-12T09:00:00.000Z",
  "domain": "example.com",
  "id": "4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c",
  "link": "https://cloud.umami.is/websites/4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c",
  "name": "Example"
}
```

### List websites

List the websites this account can see.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `websites` (list): The websites

**Example output**

```json
{
  "count": 1,
  "websites": [
    {
      "created_at": "2026-01-12T09:00:00.000Z",
      "domain": "example.com",
      "id": "4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c",
      "link": "https://cloud.umami.is/websites/4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c",
      "name": "Example"
    }
  ]
}
```
