Class: Umami::Client

Inherits:

Object

Object
Umami::Client

show all

Defined in:: lib/umami/client.rb

Overview

The Client class provides methods to interact with the Umami API.

See Also:

Umami API Documentation

Instance Attribute Summary collapse

#request_timeout ⇒ Object readonly
Returns the value of attribute request_timeout.
#uri_base ⇒ Object readonly
Returns the value of attribute uri_base.

Instance Method Summary collapse

#add_team_user(team_id, user_id, role) ⇒ Hash
Add a user to a team.
#admin_teams(params = {}) ⇒ Hash
Get all teams (admin access required, self-hosted only).
#admin_users(params = {}) ⇒ Hash
Get all users (admin access required, self-hosted only).
#admin_websites(params = {}) ⇒ Hash
Get all websites (admin access required, self-hosted only).
#authenticate ⇒ void
Authenticate with the Umami API using username and password.
#cloud? ⇒ Boolean
Check if the client is configured for Umami Cloud.
#create_report(params = {}) ⇒ Hash
Create a new report.
#create_team(name) ⇒ Hash
Create a new team.
#create_user(username, password, role, id: nil) ⇒ Hash
Create a new user.
#create_website(params = {}) ⇒ Hash
Create a new website.
#delete_link(link_id) ⇒ Hash
Delete a link.
#delete_pixel(pixel_id) ⇒ Hash
Delete a pixel.
#delete_report(report_id) ⇒ Hash
Delete a report.
#delete_team(team_id) ⇒ Hash
Delete a team.
#delete_team_user(team_id, user_id) ⇒ Hash
Remove a user from a team.
#delete_user(user_id) ⇒ Hash
Delete a user.
#delete_website(website_id) ⇒ Hash
Delete a website.
#event_data_events(website_id, params = {}) ⇒ Object deprecated Deprecated.
Use #website_event_data_events instead
#event_data_fields(website_id, params = {}) ⇒ Object deprecated Deprecated.
Use #website_event_data_fields instead
#event_data_stats(website_id, params = {}) ⇒ Object deprecated Deprecated.
Use #website_event_data_stats instead
#initialize(options = {}) ⇒ Client constructor
Initialize a new Umami API client.
#join_team(access_code) ⇒ Hash
Join a team.
#link(link_id) ⇒ Hash
Get a link by ID.
#links(params = {}) ⇒ Hash
Get all links.
#me ⇒ Hash
Get information about the current authenticated user.
#my_teams(params = {}) ⇒ Hash
Get all teams for the current authenticated user.
#my_websites(params = {}) ⇒ Hash
Get all websites for the current authenticated user.
#pixel(pixel_id) ⇒ Hash
Get a pixel by ID.
#pixels(params = {}) ⇒ Hash
Get all pixels.
#realtime(website_id) ⇒ Hash
Get realtime stats for a website (last 30 minutes).
#report(report_id) ⇒ Hash
Get a report by ID.
#report_attribution(params = {}) ⇒ Hash
Run an attribution report.
#report_breakdown(params = {}) ⇒ Hash
Run a breakdown report.
#report_funnel(params = {}) ⇒ Hash
Run a funnel report.
#report_goals(params = {}) ⇒ Hash
Run a goals report.
#report_journey(params = {}) ⇒ Hash
Run a journey report.
#report_retention(params = {}) ⇒ Hash
Run a retention report.
#report_revenue(params = {}) ⇒ Hash
Run a revenue report.
#report_utm(params = {}) ⇒ Hash
Run a UTM report.
#reports(params = {}) ⇒ Hash
Get all reports.
#reset_website(website_id) ⇒ Hash
Reset a website's data.
#self_hosted? ⇒ Boolean
Check if the client is configured for a self-hosted Umami instance.
#send_event(payload, user_agent: default_user_agent) ⇒ Hash
Send an event to Umami.
#team(team_id) ⇒ Hash
Get a team by ID.
#team_user(team_id, user_id) ⇒ Hash
Get a user in a team.
#team_users(team_id, params = {}) ⇒ Hash
Get all users in a team.
#team_websites(team_id, params = {}) ⇒ Hash
Get all websites for a team.
#teams(params = {}) ⇒ Hash
Get all teams.
#update_link(link_id, params = {}) ⇒ Hash
Update a link.
#update_pixel(pixel_id, params = {}) ⇒ Hash
Update a pixel.
#update_report(report_id, params = {}) ⇒ Hash
Update a report.
#update_team(team_id, params = {}) ⇒ Hash
Update a team.
#update_team_user(team_id, user_id, role) ⇒ Hash
Update a user's role in a team.
#update_user(user_id, params = {}) ⇒ Hash
Update a user.
#update_website(website_id, params = {}) ⇒ Hash
Update a website.
#user(user_id) ⇒ Hash
Get a user by ID.
#user_teams(user_id, params = {}) ⇒ Hash
Get all teams for a user.
#user_websites(user_id, params = {}) ⇒ Hash
Get all websites for a user.
#users(params = {}) ⇒ Hash deprecated Deprecated.
Use #admin_users instead
#verify_token ⇒ Hash
Verify the authentication token.
#website(website_id) ⇒ Hash
Get a website by ID.
#website_active_visitors(website_id) ⇒ Hash
Get active visitors for a website (last 5 minutes).
#website_event_data(website_id, event_id) ⇒ Array<Hash>
Get event data for an individual event.
#website_event_data_events(website_id, params = {}) ⇒ Array<Hash>
Get event data names, properties, and counts.
#website_event_data_fields(website_id, params = {}) ⇒ Array<Hash>
Get event data fields within a time range.
#website_event_data_properties(website_id, params = {}) ⇒ Array<Hash>
Get event name and property counts.
#website_event_data_stats(website_id, params = {}) ⇒ Array<Hash>
Get aggregated event statistics.
#website_event_data_values(website_id, params = {}) ⇒ Array<Hash>
Get event data value counts for a given event and property.
#website_events(website_id, params = {}) ⇒ Array<Hash>
Get website events within a time range.
#website_events_list(website_id, params = {}) ⇒ Hash
Get website event details within a time range (paginated list).
#website_events_series(website_id, params = {}) ⇒ Array<Hash>
Get website events series within a time range.
#website_metrics(website_id, params = {}) ⇒ Array<Hash>
Get website metrics.
#website_metrics_expanded(website_id, params = {}) ⇒ Array<Hash>
Get expanded website metrics with detailed engagement data.
#website_pageviews(website_id, params = {}) ⇒ Hash
Get website pageviews within a time range.
#website_session(website_id, session_id) ⇒ Hash
Get details for an individual session.
#website_session_activity(website_id, session_id, params = {}) ⇒ Array<Hash>
Get activity for an individual session.
#website_session_data_properties(website_id, params = {}) ⇒ Array<Hash>
Get session data property counts.
#website_session_data_values(website_id, params = {}) ⇒ Array<Hash>
Get session data value counts for a property.
#website_session_properties(website_id, session_id) ⇒ Array<Hash>
Get properties for an individual session.
#website_sessions(website_id, params = {}) ⇒ Hash
Get website sessions within a time range.
#website_sessions_stats(website_id, params = {}) ⇒ Hash
Get summarized session statistics.
#website_sessions_weekly(website_id, params = {}) ⇒ Array<Array>
Get session counts by hour of weekday.
#website_stats(website_id, params = {}) ⇒ Hash
Get website statistics.
#websites(params = {}) ⇒ Hash
Get all websites.

Constructor Details

#initialize(options = {}) ⇒ `Client`

Initialize a new Umami API client

Parameters:

options (Hash) (defaults to: {}) —
options to create a client with.

Options Hash (options):

:uri_base (String) —
The base URI for the Umami API
:request_timeout (Integer) —
Request timeout in seconds
:access_token (String) —
Access token for authentication
:username (String) —
Username for authentication (only for self-hosted instances)
:password (String) —
Password for authentication (only for self-hosted instances)

# File 'lib/umami/client.rb', line 19

def initialize(options = {})
  @config = options[:config] || Umami.configuration
  @config.validate!  # Validate the configuration before using it

  @uri_base = options[:uri_base] || @config.uri_base
  @request_timeout = options[:request_timeout] || @config.request_timeout
  @access_token = options[:access_token] || @config.access_token
  @username = options[:username] || @config.username
  @password = options[:password] || @config.password

  validate_client_options

  authenticate if @access_token.nil?
end

Instance Attribute Details

#request_timeout ⇒ `Object` (readonly)

Returns the value of attribute request_timeout.



9
10
11

# File 'lib/umami/client.rb', line 9

def request_timeout
  @request_timeout
end

#uri_base ⇒ `Object` (readonly)

Returns the value of attribute uri_base.



9
10
11

# File 'lib/umami/client.rb', line 9

def uri_base
  @uri_base
end

Instance Method Details

#add_team_user(team_id, user_id, role) ⇒ `Hash`

Add a user to a team

Parameters:

team_id (String) —
The team's ID
user_id (String) —
The user's ID
role (String) —
The user's role in the team ('team-manager', 'team-member', or 'team-view-only')

Returns:

(Hash) —
Added team user details

See Also:

https://umami.is/docs/api/teams#post-/api/teams/:teamid/users



315
316
317

# File 'lib/umami/client.rb', line 315

def add_team_user(team_id, user_id, role)
  post("/api/teams/#{team_id}/users", { userId: user_id, role: role })
end

#admin_teams(params = {}) ⇒ `Hash`

Get all teams (admin access required, self-hosted only)

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page (default: 20)

Returns:

(Hash) —
Paginated list of all teams

See Also:

https://umami.is/docs/api/admin#get-/api/admin/teams



144
145
146

# File 'lib/umami/client.rb', line 144

def admin_teams(params = {})
  get("/api/admin/teams", params)
end

#admin_users(params = {}) ⇒ `Hash`

Get all users (admin access required, self-hosted only)

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page (default: 20)

Returns:

(Hash) —
Paginated list of all users

See Also:

https://umami.is/docs/api/admin#get-/api/admin/users



120
121
122

# File 'lib/umami/client.rb', line 120

def admin_users(params = {})
  get("/api/admin/users", params)
end

#admin_websites(params = {}) ⇒ `Hash`

Get all websites (admin access required, self-hosted only)

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page (default: 20)

Returns:

(Hash) —
Paginated list of all websites

See Also:

https://umami.is/docs/api/admin#get-/api/admin/websites



132
133
134

# File 'lib/umami/client.rb', line 132

def admin_websites(params = {})
  get("/api/admin/websites", params)
end

#authenticate ⇒ `void`

This method returns an undefined value.

Authenticate with the Umami API using username and password

This method is called automatically when initializing the client if an access token is not provided. It sets the @access_token instance variable upon successful authentication.

Raises:

(Umami::AuthenticationError) —
if username or password is missing, or if authentication fails

See Also:

https://umami.is/docs/api/authentication#post-/api/auth/login

# File 'lib/umami/client.rb', line 66

def authenticate
  raise Umami::AuthenticationError, "Username and password are required for authentication" if @username.nil? || @password.nil?

  response = connection.post("/api/auth/login") do |req|
    req.body = { username: @username, password: @password }.to_json
  end

  data = JSON.parse(response.body)
  @access_token = data["token"]
rescue Faraday::Error, JSON::ParserError => e
  raise Umami::AuthenticationError, "Authentication failed: #{e.message}"
end

#cloud? ⇒ `Boolean`

Check if the client is configured for Umami Cloud

Returns:

(Boolean) —
true if using Umami Cloud, false otherwise



37
38
39

# File 'lib/umami/client.rb', line 37

def cloud?
  @uri_base == Umami::Configuration::UMAMI_CLOUD_URL
end

#create_report(params = {}) ⇒ `Hash`

Create a new report

Parameters:

params (Hash) (defaults to: {}) —
Report parameters

Options Hash (params):

:websiteId (String) —
Website ID (required)
:type (String) —
Report type (required)
:name (String) —
Report name (required)
:description (String) —
Report description
:parameters (Hash) —
Report-specific parameters

Returns:

(Hash) —
Created report details

See Also:

https://umami.is/docs/api/reports#post-/api/reports



1095
1096
1097

# File 'lib/umami/client.rb', line 1095

def create_report(params = {})
  post("/api/reports", params)
end

#create_team(name) ⇒ `Hash`

Create a new team

Parameters:

name (String) —
The team's name

Returns:

(Hash) —
Created team details

See Also:

https://umami.is/docs/api/teams#post-/api/teams



241
242
243

# File 'lib/umami/client.rb', line 241

def create_team(name)
  post("/api/teams", { name: name })
end

#create_user(username, password, role, id: nil) ⇒ `Hash`

Create a new user

Parameters:

username (String) —
The user's username
password (String) —
The user's password
role (String) —
The user's role ('admin', 'user', or 'view-only')
id (String, nil) (defaults to: nil) —
Optional UUID to assign to the user

Returns:

(Hash) —
Created user details

See Also:

https://umami.is/docs/api/users#post-/api/users

# File 'lib/umami/client.rb', line 158

def create_user(username, password, role, id: nil)
  params = { username: username, password: password, role: role }
  params[:id] = id if id
  post("/api/users", params)
end

#create_website(params = {}) ⇒ `Hash`

Create a new website

Parameters:

params (Hash) (defaults to: {}) —
Website parameters

Options Hash (params):

:name (String) —
The name of the website in Umami (required)
:domain (String) —
The full domain of the tracked website (required)
:shareId (String) —
A unique string to enable a share url (optional)
:teamId (String) —
The ID of the team the website will be created under (optional)
:id (String) —
Force a specific UUID for the website (optional)

Returns:

(Hash) —
Created website details

See Also:

https://umami.is/docs/api/websites#post-/api/websites



388
389
390

# File 'lib/umami/client.rb', line 388

def create_website(params = {})
  post("/api/websites", params)
end

#delete_link(link_id) ⇒ `Hash`

Delete a link

Parameters:

link_id (String) —
The link's ID

Returns:

(Hash) —
Confirmation message

See Also:

https://umami.is/docs/api/links#delete-/api/links/:linkid



1022
1023
1024

# File 'lib/umami/client.rb', line 1022

def delete_link(link_id)
  delete("/api/links/#{link_id}")
end

#delete_pixel(pixel_id) ⇒ `Hash`

Delete a pixel

Parameters:

pixel_id (String) —
The pixel's ID

Returns:

(Hash) —
Confirmation message

See Also:

https://umami.is/docs/api/pixels#delete-/api/pixels/:pixelid



1066
1067
1068

# File 'lib/umami/client.rb', line 1066

def delete_pixel(pixel_id)
  delete("/api/pixels/#{pixel_id}")
end

#delete_report(report_id) ⇒ `Hash`

Delete a report

Parameters:

report_id (String) —
The report's ID

Returns:

(Hash) —
Confirmation message

See Also:

https://umami.is/docs/api/reports#delete-/api/reports/:reportid



1126
1127
1128

# File 'lib/umami/client.rb', line 1126

def delete_report(report_id)
  delete("/api/reports/#{report_id}")
end

#delete_team(team_id) ⇒ `Hash`

Delete a team

Parameters:

team_id (String) —
The team's ID

Returns:

(Hash) —
Confirmation message

See Also:

https://umami.is/docs/api/teams#delete-/api/teams/:teamid



291
292
293

# File 'lib/umami/client.rb', line 291

def delete_team(team_id)
  delete("/api/teams/#{team_id}")
end

#delete_team_user(team_id, user_id) ⇒ `Hash`

Remove a user from a team

Parameters:

team_id (String) —
The team's ID
user_id (String) —
The user's ID

Returns:

(Hash) —
Confirmation message

See Also:

https://umami.is/docs/api/teams#delete-/api/teams/:teamid/users/:userid



346
347
348

# File 'lib/umami/client.rb', line 346

def delete_team_user(team_id, user_id)
  delete("/api/teams/#{team_id}/users/#{user_id}")
end

#delete_user(user_id) ⇒ `Hash`

Delete a user

Parameters:

user_id (String) —
The user's ID

Returns:

(Hash) —
Confirmation message

See Also:

https://umami.is/docs/api/users#delete-/api/users/:userid



204
205
206

# File 'lib/umami/client.rb', line 204

def delete_user(user_id)
  delete("/api/users/#{user_id}")
end

#delete_website(website_id) ⇒ `Hash`

Delete a website

Parameters:

website_id (String) —
The website's ID

Returns:

(Hash) —
Confirmation message

See Also:

https://umami.is/docs/api/websites#delete-/api/websites/:websiteid



419
420
421

# File 'lib/umami/client.rb', line 419

def delete_website(website_id)
  delete("/api/websites/#{website_id}")
end

#event_data_events(website_id, params = {}) ⇒ `Object`

Deprecated.

Use #website_event_data_events instead

# File 'lib/umami/client.rb', line 953

def event_data_events(website_id, params = {})
  warn "[DEPRECATION] `event_data_events` is deprecated. Use `website_event_data_events` instead."
  website_event_data_events(website_id, params)
end

#event_data_fields(website_id, params = {}) ⇒ `Object`

Deprecated.

Use #website_event_data_fields instead

# File 'lib/umami/client.rb', line 959

def event_data_fields(website_id, params = {})
  warn "[DEPRECATION] `event_data_fields` is deprecated. Use `website_event_data_fields` instead."
  website_event_data_fields(website_id, params)
end

#event_data_stats(website_id, params = {}) ⇒ `Object`

Deprecated.

Use #website_event_data_stats instead

# File 'lib/umami/client.rb', line 965

def event_data_stats(website_id, params = {})
  warn "[DEPRECATION] `event_data_stats` is deprecated. Use `website_event_data_stats` instead."
  website_event_data_stats(website_id, params)
end

#join_team(access_code) ⇒ `Hash`

Join a team

Parameters:

access_code (String) —
The team's access code

Returns:

(Hash) —
Joined team details

See Also:

https://umami.is/docs/api/teams#post-/api/teams/join



261
262
263

# File 'lib/umami/client.rb', line 261

def join_team(access_code)
  post("/api/teams/join", { accessCode: access_code })
end

#link(link_id) ⇒ `Hash`

Get a link by ID

Parameters:

link_id (String) —
The link's ID

Returns:

(Hash) —
Link details

See Also:

https://umami.is/docs/api/links#get-/api/links/:linkid



1000
1001
1002

# File 'lib/umami/client.rb', line 1000

def link(link_id)
  get("/api/links/#{link_id}")
end

#links(params = {}) ⇒ `Hash`

Get all links

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of links

See Also:

https://umami.is/docs/api/links#get-/api/links



991
992
993

# File 'lib/umami/client.rb', line 991

def links(params = {})
  get("/api/links", params)
end

#me ⇒ `Hash`

Get information about the current authenticated user

Returns:

(Hash) —
Current user information including token, authKey, shareToken, and user details

See Also:

https://umami.is/docs/api/me#get-/api/me



85
86
87

# File 'lib/umami/client.rb', line 85

def me
  get("/api/me")
end

#my_teams(params = {}) ⇒ `Hash`

Get all teams for the current authenticated user

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of teams with members

See Also:

https://umami.is/docs/api/me#get-/api/me/teams



96
97
98

# File 'lib/umami/client.rb', line 96

def my_teams(params = {})
  get("/api/me/teams", params)
end

#my_websites(params = {}) ⇒ `Hash`

Get all websites for the current authenticated user

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:includeTeams (Boolean) —
Include websites where user is team owner

Returns:

(Hash) —
Paginated list of websites

See Also:

https://umami.is/docs/api/me#get-/api/me/websites



106
107
108

# File 'lib/umami/client.rb', line 106

def my_websites(params = {})
  get("/api/me/websites", params)
end

#pixel(pixel_id) ⇒ `Hash`

Get a pixel by ID

Parameters:

pixel_id (String) —
The pixel's ID

Returns:

(Hash) —
Pixel details

See Also:

https://umami.is/docs/api/pixels#get-/api/pixels/:pixelid



1045
1046
1047

# File 'lib/umami/client.rb', line 1045

def pixel(pixel_id)
  get("/api/pixels/#{pixel_id}")
end

#pixels(params = {}) ⇒ `Hash`

Get all pixels

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of pixels

See Also:

https://umami.is/docs/api/pixels#get-/api/pixels



1036
1037
1038

# File 'lib/umami/client.rb', line 1036

def pixels(params = {})
  get("/api/pixels", params)
end

#realtime(website_id) ⇒ `Hash`

Get realtime stats for a website (last 30 minutes)

Parameters:

website_id (String) —
The website's ID

Returns:

(Hash) —
Realtime data including countries, urls, referrers, events, series, totals

See Also:

https://umami.is/docs/api/realtime#get-/api/realtime/:websiteid



977
978
979

# File 'lib/umami/client.rb', line 977

def realtime(website_id)
  get("/api/realtime/#{website_id}")
end

#report(report_id) ⇒ `Hash`

Get a report by ID

Parameters:

report_id (String) —
The report's ID

Returns:

(Hash) —
Report details

See Also:

https://umami.is/docs/api/reports#get-/api/reports/:reportid



1104
1105
1106

# File 'lib/umami/client.rb', line 1104

def report(report_id)
  get("/api/reports/#{report_id}")
end

#report_attribution(params = {}) ⇒ `Hash`

Run an attribution report

Parameters:

params (Hash) (defaults to: {}) —
Report parameters

Options Hash (params):

:websiteId (String) —
Website ID (required)
:startDate (String) —
Start date in ISO 8601 format (required)
:endDate (String) —
End date in ISO 8601 format (required)
:model (String) —
Attribution model ('firstClick' or 'lastClick')
:type (String) —
Attribution type ('path' or 'event')
:step (Integer) —
Step number
:filters (Hash) —
Filter criteria (path, referrer, title, query, browser, os, device, country, region, city, hostname, tag, segment, cohort)

Returns:

(Hash) —
Attribution report data

See Also:

https://umami.is/docs/api/reports#post-/api/reports/attribution



1142
1143
1144

# File 'lib/umami/client.rb', line 1142

def report_attribution(params = {})
  post("/api/reports/attribution", params)
end

#report_breakdown(params = {}) ⇒ `Hash`

Run a breakdown report

Parameters:

params (Hash) (defaults to: {}) —
Report parameters

Options Hash (params):

:websiteId (String) —
Website ID (required)
:startDate (String) —
Start date in ISO 8601 format (required)
:endDate (String) —
End date in ISO 8601 format (required)
:fields (Array<String>) —
Fields to break down by (path, title, query, referrer, browser, os, device, country, region, city, hostname, tag, event)
:filters (Hash) —
Filter criteria (path, referrer, title, query, browser, os, device, country, region, city, hostname, tag, segment, cohort)

Returns:

(Hash) —
Breakdown report data

See Also:

https://umami.is/docs/api/reports#post-/api/reports/breakdown



1156
1157
1158

# File 'lib/umami/client.rb', line 1156

def report_breakdown(params = {})
  post("/api/reports/breakdown", params)
end

#report_funnel(params = {}) ⇒ `Hash`

Run a funnel report

Parameters:

params (Hash) (defaults to: {}) —
Report parameters

Options Hash (params):

:websiteId (String) —
Website ID (required)
:startDate (String) —
Start date in ISO 8601 format (required)
:endDate (String) —
End date in ISO 8601 format (required)
:steps (Array<Hash>) —
Funnel steps (minimum 2, each with type and value)
:window (Integer) —
Number of days between steps
:filters (Hash) —
Filter criteria (path, referrer, title, query, browser, os, device, country, region, city, hostname, tag, segment, cohort)

Returns:

(Hash) —
Funnel report data with conversion and drop-off rates

See Also:

https://umami.is/docs/api/reports#post-/api/reports/funnel



1171
1172
1173

# File 'lib/umami/client.rb', line 1171

def report_funnel(params = {})
  post("/api/reports/funnel", params)
end

#report_goals(params = {}) ⇒ `Hash`

Run a goals report

Parameters:

params (Hash) (defaults to: {}) —
Report parameters

Options Hash (params):

:websiteId (String) —
Website ID (required)
:startDate (String) —
Start date in ISO 8601 format (required)
:endDate (String) —
End date in ISO 8601 format (required)
:type (String) —
Goal type ('path' or 'event')
:value (String) —
Goal value
:filters (Hash) —
Filter criteria (path, referrer, title, query, browser, os, device, country, region, city, hostname, tag, segment, cohort)

Returns:

(Hash) —
Goals report data

See Also:

https://umami.is/docs/api/reports#post-/api/reports/goals



1186
1187
1188

# File 'lib/umami/client.rb', line 1186

def report_goals(params = {})
  post("/api/reports/goals", params)
end

#report_journey(params = {}) ⇒ `Hash`

Run a journey report

Parameters:

params (Hash) (defaults to: {}) —
Report parameters

Options Hash (params):

:websiteId (String) —
Website ID (required)
:startDate (String) —
Start date in ISO 8601 format (required)
:endDate (String) —
End date in ISO 8601 format (required)
:steps (Integer) —
Number of steps (3-7)
:startStep (String) —
Starting step path
:endStep (String) —
Ending step path
:filters (Hash) —
Filter criteria (path, referrer, title, query, browser, os, device, country, region, city, hostname, tag, segment, cohort)

Returns:

(Hash) —
Journey report data showing user navigation paths

See Also:

https://umami.is/docs/api/reports#post-/api/reports/journey



1202
1203
1204

# File 'lib/umami/client.rb', line 1202

def report_journey(params = {})
  post("/api/reports/journey", params)
end

#report_retention(params = {}) ⇒ `Hash`

Run a retention report

Parameters:

params (Hash) (defaults to: {}) —
Report parameters

Options Hash (params):

:websiteId (String) —
Website ID (required)
:startDate (String) —
Start date in ISO 8601 format (required)
:endDate (String) —
End date in ISO 8601 format (required)
:timezone (String) —
Timezone (e.g., 'America/Los_Angeles') (required)
:filters (Hash) —
Filter criteria (path, referrer, title, query, browser, os, device, country, region, city, hostname, tag, segment, cohort)

Returns:

(Hash) —
Retention report data with day-based return rates

See Also:

https://umami.is/docs/api/reports#post-/api/reports/retention



1216
1217
1218

# File 'lib/umami/client.rb', line 1216

def report_retention(params = {})
  post("/api/reports/retention", params)
end

#report_revenue(params = {}) ⇒ `Hash`

Run a revenue report

Parameters:

params (Hash) (defaults to: {}) —
Report parameters

Options Hash (params):

:websiteId (String) —
Website ID (required)
:startDate (String) —
Start date in ISO 8601 format (required)
:endDate (String) —
End date in ISO 8601 format (required)
:timezone (String) —
Timezone (e.g., 'America/Los_Angeles') (required)
:currency (String) —
ISO 4217 currency code
:filters (Hash) —
Filter criteria (path, referrer, title, query, browser, os, device, country, region, city, hostname, tag, segment, cohort)

Returns:

(Hash) —
Revenue report data

See Also:

https://umami.is/docs/api/reports#post-/api/reports/revenue



1231
1232
1233

# File 'lib/umami/client.rb', line 1231

def report_revenue(params = {})
  post("/api/reports/revenue", params)
end

#report_utm(params = {}) ⇒ `Hash`

Run a UTM report

Parameters:

params (Hash) (defaults to: {}) —
Report parameters

Options Hash (params):

:websiteId (String) —
Website ID (required)
:startDate (String) —
Start date in ISO 8601 format (required)
:endDate (String) —
End date in ISO 8601 format (required)
:filters (Hash) —
Filter criteria (path, referrer, title, query, browser, os, device, country, region, city, hostname, tag, segment, cohort)

Returns:

(Hash) —
UTM report data with campaign parameter breakdown

See Also:

https://umami.is/docs/api/reports#post-/api/reports/utm



1244
1245
1246

# File 'lib/umami/client.rb', line 1244

def report_utm(params = {})
  post("/api/reports/utm", params)
end

#reports(params = {}) ⇒ `Hash`

Get all reports

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:websiteId (String) —
Website ID to filter by
:type (String) —
Report type to filter by ('attribution', 'breakdown', 'funnel', 'goal', 'journey', 'retention', 'revenue', 'utm')
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of reports

See Also:

https://umami.is/docs/api/reports#get-/api/reports



1081
1082
1083

# File 'lib/umami/client.rb', line 1081

def reports(params = {})
  get("/api/reports", params)
end

#reset_website(website_id) ⇒ `Hash`

Reset a website's data

Parameters:

website_id (String) —
The website's ID

Returns:

(Hash) —
Confirmation message

See Also:

https://umami.is/docs/api/websites#post-/api/websites/:websiteid/reset



428
429
430

# File 'lib/umami/client.rb', line 428

def reset_website(website_id)
  post("/api/websites/#{website_id}/reset")
end

#self_hosted? ⇒ `Boolean`

Check if the client is configured for a self-hosted Umami instance

Returns:

(Boolean) —
true if using a self-hosted instance, false otherwise



44
45
46

# File 'lib/umami/client.rb', line 44

def self_hosted?
  !cloud?
end

#send_event(payload, user_agent: default_user_agent) ⇒ `Hash`

Note:

No authentication required. Uses https://cloud.umami.is for Umami Cloud.

Send an event to Umami

This method uses a separate connection that:

Does NOT include Authorization header (not required for /api/send)
Uses https://cloud.umami.is for Umami Cloud (different from the main API URL)
Includes a User-Agent header (mandatory per API docs)

Parameters:

payload (Hash) —
Event payload
user_agent (String) (defaults to: default_user_agent) —
Custom User-Agent header (defaults to "umami-ruby/VERSION")

Options Hash (payload):

:hostname (String) —
Name of host (required)
:language (String) —
Language of visitor (e.g., "en-US")
:referrer (String) —
Referrer URL
:screen (String) —
Screen resolution (e.g., "1920x1080")
:title (String) —
Page title
:url (String) —
Page URL (required)
:website (String) —
Website ID (required)
:name (String) —
Name of the event
:tag (String) —
Additional tag description
:id (String) —
Session identifier
:data (Hash) —
Additional data for the event

Returns:

(Hash) —
Response with cache, sessionId, and visitId

See Also:

https://umami.is/docs/api/sending-stats



1273
1274
1275

# File 'lib/umami/client.rb', line 1273

def send_event(payload, user_agent: default_user_agent)
  send_post("/api/send", { type: "event", payload: payload }, user_agent: user_agent)
end

#team(team_id) ⇒ `Hash`

Get a team by ID

Parameters:

team_id (String) —
The team's ID

Returns:

(Hash) —
Team details

See Also:

https://umami.is/docs/api/teams#get-/api/teams/:teamid



270
271
272

# File 'lib/umami/client.rb', line 270

def team(team_id)
  get("/api/teams/#{team_id}")
end

#team_user(team_id, user_id) ⇒ `Hash`

Get a user in a team

Parameters:

team_id (String) —
The team's ID
user_id (String) —
The user's ID

Returns:

(Hash) —
Team user details

See Also:

https://umami.is/docs/api/teams#get-/api/teams/:teamid/users/:userid



325
326
327

# File 'lib/umami/client.rb', line 325

def team_user(team_id, user_id)
  get("/api/teams/#{team_id}/users/#{user_id}")
end

#team_users(team_id, params = {}) ⇒ `Hash`

Get all users in a team

Parameters:

team_id (String) —
The team's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of team users

See Also:

https://umami.is/docs/api/teams#get-/api/teams/:teamid/users



304
305
306

# File 'lib/umami/client.rb', line 304

def team_users(team_id, params = {})
  get("/api/teams/#{team_id}/users", params)
end

#team_websites(team_id, params = {}) ⇒ `Hash`

Get all websites for a team

Parameters:

team_id (String) —
The team's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of team websites

See Also:

https://umami.is/docs/api/teams#get-/api/teams/:teamid/websites



359
360
361

# File 'lib/umami/client.rb', line 359

def team_websites(team_id, params = {})
  get("/api/teams/#{team_id}/websites", params)
end

#teams(params = {}) ⇒ `Hash`

Get all teams

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of teams

See Also:

https://umami.is/docs/api/teams#get-/api/teams



252
253
254

# File 'lib/umami/client.rb', line 252

def teams(params = {})
  get("/api/teams", params)
end

#update_link(link_id, params = {}) ⇒ `Hash`

Update a link

Parameters:

link_id (String) —
The link's ID
params (Hash) (defaults to: {}) —
Link parameters to update

Options Hash (params):

:name (String) —
Link name
:url (String) —
Destination URL
:slug (String) —
URL slug (minimum 8 characters)

Returns:

(Hash) —
Updated link details

See Also:

https://umami.is/docs/api/links#post-/api/links/:linkid



1013
1014
1015

# File 'lib/umami/client.rb', line 1013

def update_link(link_id, params = {})
  post("/api/links/#{link_id}", params)
end

#update_pixel(pixel_id, params = {}) ⇒ `Hash`

Update a pixel

Parameters:

pixel_id (String) —
The pixel's ID
params (Hash) (defaults to: {}) —
Pixel parameters to update

Options Hash (params):

:name (String) —
Pixel name
:slug (String) —
URL slug (minimum 8 characters)

Returns:

(Hash) —
Updated pixel details

See Also:

https://umami.is/docs/api/pixels#post-/api/pixels/:pixelid



1057
1058
1059

# File 'lib/umami/client.rb', line 1057

def update_pixel(pixel_id, params = {})
  post("/api/pixels/#{pixel_id}", params)
end

#update_report(report_id, params = {}) ⇒ `Hash`

Update a report

Parameters:

report_id (String) —
The report's ID
params (Hash) (defaults to: {}) —
Report parameters to update

Options Hash (params):

:name (String) —
Report name
:description (String) —
Report description
:parameters (Hash) —
Report-specific parameters

Returns:

(Hash) —
Updated report details

See Also:

https://umami.is/docs/api/reports#post-/api/reports/:reportid



1117
1118
1119

# File 'lib/umami/client.rb', line 1117

def update_report(report_id, params = {})
  post("/api/reports/#{report_id}", params)
end

#update_team(team_id, params = {}) ⇒ `Hash`

Update a team

Parameters:

team_id (String) —
The team's ID
params (Hash) (defaults to: {}) —
Team parameters to update

Options Hash (params):

:name (String) —
The team's new name
:accessCode (String) —
The team's new access code

Returns:

(Hash) —
Updated team details

See Also:

https://umami.is/docs/api/teams#post-/api/teams/:teamid



282
283
284

# File 'lib/umami/client.rb', line 282

def update_team(team_id, params = {})
  post("/api/teams/#{team_id}", params)
end

#update_team_user(team_id, user_id, role) ⇒ `Hash`

Update a user's role in a team

Parameters:

team_id (String) —
The team's ID
user_id (String) —
The user's ID
role (String) —
The user's new role ('team-manager', 'team-member', or 'team-view-only')

Returns:

(Hash) —
Confirmation message

See Also:

https://umami.is/docs/api/teams#post-/api/teams/:teamid/users/:userid



336
337
338

# File 'lib/umami/client.rb', line 336

def update_team_user(team_id, user_id, role)
  post("/api/teams/#{team_id}/users/#{user_id}", { role: role })
end

#update_user(user_id, params = {}) ⇒ `Hash`

Update a user

Parameters:

user_id (String) —
The user's ID
params (Hash) (defaults to: {}) —
User parameters to update

Options Hash (params):

:username (String) —
The user's new username
:password (String) —
The user's new password
:role (String) —
The user's new role ('admin', 'user', or 'view-only')

Returns:

(Hash) —
Updated user details

See Also:

https://umami.is/docs/api/users#post-/api/users/:userid



195
196
197

# File 'lib/umami/client.rb', line 195

def update_user(user_id, params = {})
  post("/api/users/#{user_id}", params)
end

#update_website(website_id, params = {}) ⇒ `Hash`

Update a website

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Website parameters to update

Options Hash (params):

:name (String) —
The name of the website in Umami (required)
:domain (String) —
The full domain of the tracked website (required)
:shareId (String) —
A unique string to enable a share url

Returns:

(Hash) —
Updated website details

See Also:

https://umami.is/docs/api/websites#post-/api/websites/:websiteid



410
411
412

# File 'lib/umami/client.rb', line 410

def update_website(website_id, params = {})
  post("/api/websites/#{website_id}", params)
end

#user(user_id) ⇒ `Hash`

Get a user by ID

Parameters:

user_id (String) —
The user's ID

Returns:

(Hash) —
User details

See Also:

https://umami.is/docs/api/users#get-/api/users/:userid



182
183
184

# File 'lib/umami/client.rb', line 182

def user(user_id)
  get("/api/users/#{user_id}")
end

#user_teams(user_id, params = {}) ⇒ `Hash`

Get all teams for a user

Parameters:

user_id (String) —
The user's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of user's teams

See Also:

https://umami.is/docs/api/users#get-/api/users/:userid/teams



230
231
232

# File 'lib/umami/client.rb', line 230

def user_teams(user_id, params = {})
  get("/api/users/#{user_id}/teams", params)
end

#user_websites(user_id, params = {}) ⇒ `Hash`

Get all websites for a user

Parameters:

user_id (String) —
The user's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:includeTeams (Boolean) —
Include team websites
:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of user's websites

See Also:

https://umami.is/docs/api/users#get-/api/users/:userid/websites



218
219
220

# File 'lib/umami/client.rb', line 218

def user_websites(user_id, params = {})
  get("/api/users/#{user_id}/websites", params)
end

#users(params = {}) ⇒ `Hash`

Deprecated.

Use #admin_users instead

Get all users (admin access required)

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page (default: 20)

Returns:

(Hash) —
Paginated list of all users

See Also:

https://umami.is/docs/api/admin#get-/api/admin/users



173
174
175

# File 'lib/umami/client.rb', line 173

def users(params = {})
  admin_users(params)
end

#verify_token ⇒ `Hash`

Verify the authentication token

Returns:

(Hash) —
Token verification result containing user information

See Also:

https://umami.is/docs/api/authentication#post-/api/auth/verify



52
53
54

# File 'lib/umami/client.rb', line 52

def verify_token
  post("/api/auth/verify")
end

#website(website_id) ⇒ `Hash`

Get a website by ID

Parameters:

website_id (String) —
The website's ID

Returns:

(Hash) —
Website details

See Also:

https://umami.is/docs/api/websites#get-/api/websites/:websiteid



397
398
399

# File 'lib/umami/client.rb', line 397

def website(website_id)
  get("/api/websites/#{website_id}")
end

#website_active_visitors(website_id) ⇒ `Hash`

Get active visitors for a website (last 5 minutes)

Parameters:

website_id (String) —
The website's ID

Returns:

(Hash) —
Number of active visitors

See Also:

https://umami.is/docs/api/website-stats#get-/api/websites/:websiteid/active



465
466
467

# File 'lib/umami/client.rb', line 465

def website_active_visitors(website_id)
  get("/api/websites/#{website_id}/active")
end

#website_event_data(website_id, event_id) ⇒ `Array<Hash>`

Get event data for an individual event

Parameters:

website_id (String) —
The website's ID
event_id (String) —
The event's ID

Returns:

(Array<Hash>) —
Event data properties

See Also:

https://umami.is/docs/api/events#get-/api/websites/:websiteid/event-data/:eventid



813
814
815

# File 'lib/umami/client.rb', line 813

def website_event_data(website_id, event_id)
  get("/api/websites/#{website_id}/event-data/#{event_id}")
end

#website_event_data_events(website_id, params = {}) ⇒ `Array<Hash>`

Get event data names, properties, and counts

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:event (String) —
Event name filter
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Event data with eventName, propertyName, dataType, total

See Also:

https://umami.is/docs/api/events#get-/api/websites/:websiteid/event-data/events



840
841
842

# File 'lib/umami/client.rb', line 840

def website_event_data_events(website_id, params = {})
  get("/api/websites/#{website_id}/event-data/events", params)
end

#website_event_data_fields(website_id, params = {}) ⇒ `Array<Hash>`

Get event data fields within a time range

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Event data fields with propertyName, dataType, value, total

See Also:

https://umami.is/docs/api/events#get-/api/websites/:websiteid/event-data/fields



866
867
868

# File 'lib/umami/client.rb', line 866

def website_event_data_fields(website_id, params = {})
  get("/api/websites/#{website_id}/event-data/fields", params)
end

#website_event_data_properties(website_id, params = {}) ⇒ `Array<Hash>`

Get event name and property counts

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Event properties with eventName, propertyName, total

See Also:

https://umami.is/docs/api/events#get-/api/websites/:websiteid/event-data/properties



892
893
894

# File 'lib/umami/client.rb', line 892

def website_event_data_properties(website_id, params = {})
  get("/api/websites/#{website_id}/event-data/properties", params)
end

#website_event_data_stats(website_id, params = {}) ⇒ `Array<Hash>`

Get aggregated event statistics

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Event stats with events, properties, records counts

See Also:

https://umami.is/docs/api/events#get-/api/websites/:websiteid/event-data/stats



946
947
948

# File 'lib/umami/client.rb', line 946

def website_event_data_stats(website_id, params = {})
  get("/api/websites/#{website_id}/event-data/stats", params)
end

#website_event_data_values(website_id, params = {}) ⇒ `Array<Hash>`

Get event data value counts for a given event and property

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:event (String) —
Event name (required)
:propertyName (String) —
Property name (required)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Value counts with value and total

See Also:

https://umami.is/docs/api/events#get-/api/websites/:websiteid/event-data/values



920
921
922

# File 'lib/umami/client.rb', line 920

def website_event_data_values(website_id, params = {})
  get("/api/websites/#{website_id}/event-data/values", params)
end

#website_events(website_id, params = {}) ⇒ `Array<Hash>`

Get website events within a time range

This method returns event data with optional time-series grouping. For paginated event lists with search, use #website_events_list instead.

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:unit (String) —
Time unit for grouping ('minute', 'hour', 'day', 'month', 'year')
:timezone (String) —
Timezone (e.g., 'America/Los_Angeles')

Returns:

(Array<Hash>) —
Website events

See Also:



511
512
513

# File 'lib/umami/client.rb', line 511

def website_events(website_id, params = {})
  get("/api/websites/#{website_id}/events", params)
end

#website_events_list(website_id, params = {}) ⇒ `Hash`

Get website event details within a time range (paginated list)

This method returns a paginated list of individual events with full details and supports search and filtering. For time-series grouped event data, use #website_events or #website_events_series instead.

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page (default: 20)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Hash) —
Paginated list of events with full event details

See Also:



803
804
805

# File 'lib/umami/client.rb', line 803

def website_events_list(website_id, params = {})
  get("/api/websites/#{website_id}/events", params)
end

#website_events_series(website_id, params = {}) ⇒ `Array<Hash>`

Get website events series within a time range

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:unit (String) —
Time unit for grouping ('minute', 'hour', 'day', 'month', 'year') (required)
:timezone (String) —
Timezone (e.g., 'America/Los_Angeles')
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Event series with x (event name), t (timestamp), y (count)

See Also:

https://umami.is/docs/api/website-stats#get-/api/websites/:websiteid/events/series



538
539
540

# File 'lib/umami/client.rb', line 538

def website_events_series(website_id, params = {})
  get("/api/websites/#{website_id}/events/series", params)
end

#website_metrics(website_id, params = {}) ⇒ `Array<Hash>`

Get website metrics

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:type (String) —
Metrics type (required): 'path', 'entry', 'exit', 'title', 'query', 'referrer', 'channel', 'domain', 'country', 'region', 'city', 'browser', 'os', 'device', 'language', 'screen', 'event', 'hostname', 'tag'
:limit (Integer) —
Number of results to return (default: 500)
:offset (Integer) —
Number of results to skip (default: 0)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:language (String) —
Filter by language
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Website metrics with x (value) and y (visitor count)

See Also:

https://umami.is/docs/api/website-stats#get-/api/websites/:websiteid/metrics



567
568
569

# File 'lib/umami/client.rb', line 567

def website_metrics(website_id, params = {})
  get("/api/websites/#{website_id}/metrics", params)
end

#website_metrics_expanded(website_id, params = {}) ⇒ `Array<Hash>`

Get expanded website metrics with detailed engagement data

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:type (String) —
Metrics type (required): 'path', 'entry', 'exit', 'title', 'query', 'referrer', 'channel', 'domain', 'country', 'region', 'city', 'browser', 'os', 'device', 'language', 'screen', 'event', 'hostname', 'tag'
:limit (Integer) —
Number of results to return (default: 500)
:offset (Integer) —
Number of results to skip (default: 0)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:language (String) —
Filter by language
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Expanded metrics with name, pageviews, visitors, visits, bounces, totaltime

See Also:

https://umami.is/docs/api/website-stats#get-/api/websites/:websiteid/metrics/expanded



596
597
598

# File 'lib/umami/client.rb', line 596

def website_metrics_expanded(website_id, params = {})
  get("/api/websites/#{website_id}/metrics/expanded", params)
end

#website_pageviews(website_id, params = {}) ⇒ `Hash`

Get website pageviews within a time range

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:unit (String) —
Time unit for grouping ('minute', 'hour', 'day', 'month', 'year') (required)
:timezone (String) —
Timezone (e.g., 'America/Los_Angeles')
:compare (String) —
Comparison mode ('prev' or 'yoy')
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Hash) —
Pageviews and sessions arrays with timestamp and count

See Also:

https://umami.is/docs/api/website-stats#get-/api/websites/:websiteid/pageviews



493
494
495

# File 'lib/umami/client.rb', line 493

def website_pageviews(website_id, params = {})
  get("/api/websites/#{website_id}/pageviews", params)
end

#website_session(website_id, session_id) ⇒ `Hash`

Get details for an individual session

Parameters:

website_id (String) —
The website's ID
session_id (String) —
The session's ID

Returns:

(Hash) —
Session details including browser, os, device, visits, views, events, totaltime

See Also:

https://umami.is/docs/api/sessions#get-/api/websites/:websiteid/sessions/:sessionid



690
691
692

# File 'lib/umami/client.rb', line 690

def website_session(website_id, session_id)
  get("/api/websites/#{website_id}/sessions/#{session_id}")
end

#website_session_activity(website_id, session_id, params = {}) ⇒ `Array<Hash>`

Get activity for an individual session

Parameters:

website_id (String) —
The website's ID
session_id (String) —
The session's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)

Returns:

(Array<Hash>) —
Session activity records

See Also:

https://umami.is/docs/api/sessions#get-/api/websites/:websiteid/sessions/:sessionid/activity



703
704
705

# File 'lib/umami/client.rb', line 703

def website_session_activity(website_id, session_id, params = {})
  get("/api/websites/#{website_id}/sessions/#{session_id}/activity", params)
end

#website_session_data_properties(website_id, params = {}) ⇒ `Array<Hash>`

Get session data property counts

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Property aggregations with propertyName and total

See Also:

https://umami.is/docs/api/sessions#get-/api/websites/:websiteid/session-data/properties



739
740
741

# File 'lib/umami/client.rb', line 739

def website_session_data_properties(website_id, params = {})
  get("/api/websites/#{website_id}/session-data/properties", params)
end

#website_session_data_values(website_id, params = {}) ⇒ `Array<Hash>`

Get session data value counts for a property

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:propertyName (String) —
Property name to query (required)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Hash>) —
Value aggregations with value and total

See Also:

https://umami.is/docs/api/sessions#get-/api/websites/:websiteid/session-data/values



766
767
768

# File 'lib/umami/client.rb', line 766

def website_session_data_values(website_id, params = {})
  get("/api/websites/#{website_id}/session-data/values", params)
end

#website_session_properties(website_id, session_id) ⇒ `Array<Hash>`

Get properties for an individual session

Parameters:

website_id (String) —
The website's ID
session_id (String) —
The session's ID

Returns:

(Array<Hash>) —
Session properties

See Also:

https://umami.is/docs/api/sessions#get-/api/websites/:websiteid/sessions/:sessionid/properties



713
714
715

# File 'lib/umami/client.rb', line 713

def website_session_properties(website_id, session_id)
  get("/api/websites/#{website_id}/sessions/#{session_id}/properties")
end

#website_sessions(website_id, params = {}) ⇒ `Hash`

Get website sessions within a time range

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page (default: 20)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Hash) —
Paginated list of sessions

See Also:

https://umami.is/docs/api/sessions#get-/api/websites/:websiteid/sessions



627
628
629

# File 'lib/umami/client.rb', line 627

def website_sessions(website_id, params = {})
  get("/api/websites/#{website_id}/sessions", params)
end

#website_sessions_stats(website_id, params = {}) ⇒ `Hash`

Get summarized session statistics

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Hash) —
Session statistics including pageviews, visitors, visits, countries, events

See Also:

https://umami.is/docs/api/sessions#get-/api/websites/:websiteid/sessions/stats



653
654
655

# File 'lib/umami/client.rb', line 653

def website_sessions_stats(website_id, params = {})
  get("/api/websites/#{website_id}/sessions/stats", params)
end

#website_sessions_weekly(website_id, params = {}) ⇒ `Array<Array>`

Get session counts by hour of weekday

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:timezone (String) —
Timezone (e.g., 'America/Los_Angeles') (required)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Array<Array>) —
7x24 matrix of session counts by weekday and hour

See Also:

https://umami.is/docs/api/sessions#get-/api/websites/:websiteid/sessions/weekly



680
681
682

# File 'lib/umami/client.rb', line 680

def website_sessions_weekly(website_id, params = {})
  get("/api/websites/#{website_id}/sessions/weekly", params)
end

#website_stats(website_id, params = {}) ⇒ `Hash`

Get website statistics

Parameters:

website_id (String) —
The website's ID
params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:startAt (Integer) —
Timestamp (in ms) of starting date (required)
:endAt (Integer) —
Timestamp (in ms) of end date (required)
:path (String) —
Filter by URL path
:referrer (String) —
Filter by referrer
:title (String) —
Filter by page title
:query (String) —
Filter by query string
:os (String) —
Filter by operating system
:browser (String) —
Filter by browser
:device (String) —
Filter by device type
:country (String) —
Filter by country
:region (String) —
Filter by region/state/province
:city (String) —
Filter by city
:hostname (String) —
Filter by hostname
:tag (String) —
Filter by tag
:segment (String) —
Filter by segment UUID
:cohort (String) —
Filter by cohort UUID

Returns:

(Hash) —
Website statistics including pageviews, visitors, visits, bounces, totaltime

See Also:

https://umami.is/docs/api/website-stats#get-/api/websites/:websiteid/stats



456
457
458

# File 'lib/umami/client.rb', line 456

def website_stats(website_id, params = {})
  get("/api/websites/#{website_id}/stats", params)
end

#websites(params = {}) ⇒ `Hash`

Get all websites

Parameters:

params (Hash) (defaults to: {}) —
Query parameters

Options Hash (params):

:includeTeams (Boolean) —
Include websites where user is team owner
:search (String) —
Search text
:page (Integer) —
Page number (default: 1)
:pageSize (Integer) —
Number of results per page

Returns:

(Hash) —
Paginated list of websites

See Also:

https://umami.is/docs/api/websites#get-/api/websites



374
375
376

# File 'lib/umami/client.rb', line 374

def websites(params = {})
  get("/api/websites", params)
end

Class: Umami::Client

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Instance Attribute Details

#request_timeout ⇒ Object (readonly)

#uri_base ⇒ Object (readonly)

Instance Method Details

#add_team_user(team_id, user_id, role) ⇒ Hash

#admin_teams(params = {}) ⇒ Hash

#admin_users(params = {}) ⇒ Hash

#admin_websites(params = {}) ⇒ Hash

#authenticate ⇒ void

#cloud? ⇒ Boolean

#create_report(params = {}) ⇒ Hash

#create_team(name) ⇒ Hash

#create_user(username, password, role, id: nil) ⇒ Hash

#create_website(params = {}) ⇒ Hash

#delete_link(link_id) ⇒ Hash

#delete_pixel(pixel_id) ⇒ Hash

#delete_report(report_id) ⇒ Hash

#delete_team(team_id) ⇒ Hash

#delete_team_user(team_id, user_id) ⇒ Hash

#delete_user(user_id) ⇒ Hash

#delete_website(website_id) ⇒ Hash

#event_data_events(website_id, params = {}) ⇒ Object

#event_data_fields(website_id, params = {}) ⇒ Object

#event_data_stats(website_id, params = {}) ⇒ Object

#join_team(access_code) ⇒ Hash

#link(link_id) ⇒ Hash

#links(params = {}) ⇒ Hash

#me ⇒ Hash

#my_teams(params = {}) ⇒ Hash

#my_websites(params = {}) ⇒ Hash

#pixel(pixel_id) ⇒ Hash

#pixels(params = {}) ⇒ Hash

#realtime(website_id) ⇒ Hash

#report(report_id) ⇒ Hash

#report_attribution(params = {}) ⇒ Hash

#report_breakdown(params = {}) ⇒ Hash

#report_funnel(params = {}) ⇒ Hash

#report_goals(params = {}) ⇒ Hash

#report_journey(params = {}) ⇒ Hash

#report_retention(params = {}) ⇒ Hash

#report_revenue(params = {}) ⇒ Hash

#report_utm(params = {}) ⇒ Hash

#reports(params = {}) ⇒ Hash

#reset_website(website_id) ⇒ Hash

#self_hosted? ⇒ Boolean

#send_event(payload, user_agent: default_user_agent) ⇒ Hash

#team(team_id) ⇒ Hash

#team_user(team_id, user_id) ⇒ Hash

#team_users(team_id, params = {}) ⇒ Hash

#team_websites(team_id, params = {}) ⇒ Hash

#teams(params = {}) ⇒ Hash

#update_link(link_id, params = {}) ⇒ Hash

#update_pixel(pixel_id, params = {}) ⇒ Hash

#update_report(report_id, params = {}) ⇒ Hash

#update_team(team_id, params = {}) ⇒ Hash

#update_team_user(team_id, user_id, role) ⇒ Hash

#update_user(user_id, params = {}) ⇒ Hash

#update_website(website_id, params = {}) ⇒ Hash

#user(user_id) ⇒ Hash

#user_teams(user_id, params = {}) ⇒ Hash

#user_websites(user_id, params = {}) ⇒ Hash

#users(params = {}) ⇒ Hash

#verify_token ⇒ Hash

#website(website_id) ⇒ Hash

#website_active_visitors(website_id) ⇒ Hash

#website_event_data(website_id, event_id) ⇒ Array<Hash>

#website_event_data_events(website_id, params = {}) ⇒ Array<Hash>

#website_event_data_fields(website_id, params = {}) ⇒ Array<Hash>

#website_event_data_properties(website_id, params = {}) ⇒ Array<Hash>

#website_event_data_stats(website_id, params = {}) ⇒ Array<Hash>

#website_event_data_values(website_id, params = {}) ⇒ Array<Hash>

#website_events(website_id, params = {}) ⇒ Array<Hash>

#website_events_list(website_id, params = {}) ⇒ Hash

#website_events_series(website_id, params = {}) ⇒ Array<Hash>

#initialize(options = {}) ⇒ `Client`

#request_timeout ⇒ `Object` (readonly)

#uri_base ⇒ `Object` (readonly)

#add_team_user(team_id, user_id, role) ⇒ `Hash`

#admin_teams(params = {}) ⇒ `Hash`

#admin_users(params = {}) ⇒ `Hash`

#admin_websites(params = {}) ⇒ `Hash`

#authenticate ⇒ `void`

#cloud? ⇒ `Boolean`

#create_report(params = {}) ⇒ `Hash`

#create_team(name) ⇒ `Hash`

#create_user(username, password, role, id: nil) ⇒ `Hash`

#create_website(params = {}) ⇒ `Hash`

#delete_link(link_id) ⇒ `Hash`

#delete_pixel(pixel_id) ⇒ `Hash`

#delete_report(report_id) ⇒ `Hash`

#delete_team(team_id) ⇒ `Hash`

#delete_team_user(team_id, user_id) ⇒ `Hash`

#delete_user(user_id) ⇒ `Hash`

#delete_website(website_id) ⇒ `Hash`

#event_data_events(website_id, params = {}) ⇒ `Object`

#event_data_fields(website_id, params = {}) ⇒ `Object`

#event_data_stats(website_id, params = {}) ⇒ `Object`

#join_team(access_code) ⇒ `Hash`

#link(link_id) ⇒ `Hash`

#links(params = {}) ⇒ `Hash`

#me ⇒ `Hash`

#my_teams(params = {}) ⇒ `Hash`

#my_websites(params = {}) ⇒ `Hash`

#pixel(pixel_id) ⇒ `Hash`

#pixels(params = {}) ⇒ `Hash`

#realtime(website_id) ⇒ `Hash`

#report(report_id) ⇒ `Hash`

#report_attribution(params = {}) ⇒ `Hash`

#report_breakdown(params = {}) ⇒ `Hash`

#report_funnel(params = {}) ⇒ `Hash`

#report_goals(params = {}) ⇒ `Hash`

#report_journey(params = {}) ⇒ `Hash`

#report_retention(params = {}) ⇒ `Hash`

#report_revenue(params = {}) ⇒ `Hash`

#report_utm(params = {}) ⇒ `Hash`

#reports(params = {}) ⇒ `Hash`

#reset_website(website_id) ⇒ `Hash`

#self_hosted? ⇒ `Boolean`

#send_event(payload, user_agent: default_user_agent) ⇒ `Hash`

#team(team_id) ⇒ `Hash`

#team_user(team_id, user_id) ⇒ `Hash`

#team_users(team_id, params = {}) ⇒ `Hash`

#team_websites(team_id, params = {}) ⇒ `Hash`

#teams(params = {}) ⇒ `Hash`

#update_link(link_id, params = {}) ⇒ `Hash`

#update_pixel(pixel_id, params = {}) ⇒ `Hash`

#update_report(report_id, params = {}) ⇒ `Hash`

#update_team(team_id, params = {}) ⇒ `Hash`

#update_team_user(team_id, user_id, role) ⇒ `Hash`

#update_user(user_id, params = {}) ⇒ `Hash`

#update_website(website_id, params = {}) ⇒ `Hash`

#user(user_id) ⇒ `Hash`

#user_teams(user_id, params = {}) ⇒ `Hash`

#user_websites(user_id, params = {}) ⇒ `Hash`

#users(params = {}) ⇒ `Hash`

#verify_token ⇒ `Hash`

#website(website_id) ⇒ `Hash`

#website_active_visitors(website_id) ⇒ `Hash`

#website_event_data(website_id, event_id) ⇒ `Array<Hash>`

#website_event_data_events(website_id, params = {}) ⇒ `Array<Hash>`

#website_event_data_fields(website_id, params = {}) ⇒ `Array<Hash>`

#website_event_data_properties(website_id, params = {}) ⇒ `Array<Hash>`

#website_event_data_stats(website_id, params = {}) ⇒ `Array<Hash>`

#website_event_data_values(website_id, params = {}) ⇒ `Array<Hash>`

#website_events(website_id, params = {}) ⇒ `Array<Hash>`

#website_events_list(website_id, params = {}) ⇒ `Hash`

#website_events_series(website_id, params = {}) ⇒ `Array<Hash>`

#website_metrics(website_id, params = {}) ⇒ `Array<Hash>`

#website_metrics_expanded(website_id, params = {}) ⇒ `Array<Hash>`

#website_pageviews(website_id, params = {}) ⇒ `Hash`

#website_session(website_id, session_id) ⇒ `Hash`

#website_session_activity(website_id, session_id, params = {}) ⇒ `Array<Hash>`

#website_session_data_properties(website_id, params = {}) ⇒ `Array<Hash>`

#website_session_data_values(website_id, params = {}) ⇒ `Array<Hash>`