Umami
App · 9 actions
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.
Actions
| Action | What it does |
|---|---|
| Add website | Add a website to Umami, and get the tracking code to put on its pages. |
| Delete website | Delete a website from Umami, with all its traffic data. |
| Get active visitors | Get how many people are on a website now, counted over the last 5 minutes. |
| Get current user | Who the connection signs in to Umami as. |
| 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. |
| Get stats | Get a website's visitors, visits, page views, bounce rate and average visit for a period, with the period before it. |
| Get top list | Get a website's top pages, referrers, countries, browsers, devices or events for a period. |
| Get website | Get a website's name, domain and dashboard link. |
| List websites | List the websites this account can see. |
Add website
Add a website to Umami, and get the tracking code to put on its pages.
Inputs
- Name
nametextRequired - What to call it in Umami.
- Domain
domaintextRequired - The site's domain, such as example.com.
Outputs
created_attext- When it was added (ISO 8601)
domaintext- Its domain
idtext- The website's ID
linktext- A link to its dashboard
nametext- Its name in Umami
tracking_codetext- The script tag to put on the site's pages
Example output
{
"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
websitetextRequired - The website.
Outputs
deletedtrue/false- True once deleted
idtext- The website's ID
Example output
{
"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
websitetextRequired - The website.
Outputs
visitorsnumber- People on the site now
website_idtext- The website's ID
Example output
{
"visitors": 12,
"website_id": "4f5a6b7c-8d9e-4f0a-9b1c-2d3e4f5a6b7c"
}Get current user
Who the connection signs in to Umami as.
Inputs
None.
Outputs
cloudtrue/false- True on Umami Cloud
idtext- The user's ID
roletext- Their role
usernametext- Their username
Example output
{
"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
websitetextRequired - The website.
- Period
periodtext - 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_datedate - With 'From and to dates', the first day.
- To
end_datedate - With 'From and to dates', the last day.
- By
unittext - Hour by hour, day by day or by month. Defaults to day.One of:
hour,day,month. Default:day. - Time zone
time_zonetext - The time zone the days are in, such as Europe/London. Defaults to UTC.
Outputs
countnumber- How many rows
fromtext- The first day read (YYYY-MM-DD)
pointslist- One row per hour, day or month
totext- The last day read
unittext- hour, day or month
website_idtext- The website's ID
Example output
{
"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
websitetextRequired - The website.
- Period
periodtext - 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_datedate - With 'From and to dates', the first day.
- To
end_datedate - With 'From and to dates', the last day.
- Time zone
time_zonetext - The time zone the days are in, such as Europe/London. Defaults to UTC.
Outputs
average_visit_secondsnumber- How long a visit lasted on average, in seconds
bounce_ratenumber- Visits that saw one page, as a percentage
fromtext- The first day read (YYYY-MM-DD)
pageviewsnumber- Page views
previous_pageviewsnumber- Page views in the period before
previous_visitorsnumber- Unique visitors in the period before
previous_visitsnumber- Visits in the period before
totext- The last day read
visitorsnumber- Unique visitors
visitsnumber- Visits
website_idtext- The website's ID
Example output
{
"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
websitetextRequired - The website.
- List
metrictext - 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
periodtext - 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_datedate - With 'From and to dates', the first day.
- To
end_datedate - With 'From and to dates', the last day.
- Time zone
time_zonetext - The time zone the days are in, such as Europe/London. Defaults to UTC.
- How many
limitnumber - How many to list. Defaults to 10.From 1 to 100.
Outputs
countnumber- How many are listed
fromtext- The first day read (YYYY-MM-DD)
itemslist- The list, most first
metrictext- Which list
totext- The last day read
website_idtext- The website's ID
Example output
{
"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
websitetextRequired - The website.
Outputs
created_attext- When it was added (ISO 8601)
domaintext- Its domain
idtext- The website's ID
linktext- A link to its dashboard
nametext- Its name in Umami
Example output
{
"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
countnumber- How many
websiteslist- The websites
Example output
{
"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"
}
]
}