Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Index your code
hub
/
github.com/umami-software/api-client
/ functions
Functions
89 in github.com/umami-software/api-client
⨍
Functions
89
◇
Types & classes
33
↓ 41 callers
Method
get
(url: string, params?: object, headers?: object)
src/UmamiApiClient.ts:67
↓ 26 callers
Method
post
(url: string, data?: object, headers?: object)
src/UmamiApiClient.ts:77
↓ 6 callers
Method
del
(url: string, params?: object, headers?: object)
src/UmamiApiClient.ts:93
↓ 4 callers
Method
getHeaders
(headers: any = {})
src/UmamiApiClient.ts:56
↓ 3 callers
Method
getWebsites
( params?: Umami.WebsiteSearchParams, )
src/UmamiApiClient.ts:225
↓ 2 callers
Method
getMe
()
src/UmamiApiClient.ts:502
↓ 2 callers
Method
getUsers
( params: Umami.UserSearchParams, )
src/UmamiApiClient.ts:114
↓ 2 callers
Method
getWebsiteActive
(websiteId: string)
src/UmamiApiClient.ts:231
↓ 2 callers
Method
getWebsiteMetrics
( websiteId: string, params: { type: string; startAt: number; endAt: number; u
src/UmamiApiClient.ts:346
↓ 2 callers
Method
getWebsitePageviews
( websiteId: string, params: { startAt: number; endAt: number; unit: string; t
src/UmamiApiClient.ts:370
↓ 2 callers
Method
getWebsiteStats
( websiteId: string, params: { startAt: number; endAt: number; url?: string; r
src/UmamiApiClient.ts:392
↓ 1 callers
Method
createReport
(data: { websiteId: string; name: string; type: string; description: string; parameters: {
src/UmamiApiClient.ts:186
↓ 1 callers
Method
createTeam
(data: { name: string; domain: string })
src/UmamiApiClient.ts:414
↓ 1 callers
Method
createTeamUser
( teamId: string, data: { userId: string; role: string }, )
src/UmamiApiClient.ts:443
↓ 1 callers
Method
createTeamWebsite
( teamId: string, data: { name: string; domain: string; shareId: string }, )
src/UmamiApiClient.ts:469
↓ 1 callers
Method
createUser
(data: { id?: string; username: string; password: string; role?: string; })
src/UmamiApiClient.ts:101
↓ 1 callers
Method
createWebsite
(data: { name: string; domain: string })
src/UmamiApiClient.ts:198
↓ 1 callers
Method
deleteReport
(reportId)
src/UmamiApiClient.ts:176
↓ 1 callers
Method
deleteTeam
(teamId: string)
src/UmamiApiClient.ts:490
↓ 1 callers
Method
deleteTeamUser
(teamId: string, userId: string)
src/UmamiApiClient.ts:458
↓ 1 callers
Method
deleteUser
(userId: string)
src/UmamiApiClient.ts:144
↓ 1 callers
Method
deleteWebsite
(websiteId: string)
src/UmamiApiClient.ts:217
↓ 1 callers
Method
getEventDataEvents
( websiteId: string, params: { startAt: number; endAt: number; event?: string; }
src/UmamiApiClient.ts:527
↓ 1 callers
Method
getEventDataFields
( websiteId: string, params: { startAt: number; endAt: number; }, )
src/UmamiApiClient.ts:560
↓ 1 callers
Method
getEventDataStats
( websiteId: string, params: { startAt: number; endAt: number; }, )
src/UmamiApiClient.ts:538
↓ 1 callers
Method
getEventDataValues
( websiteId: string, params: { startAt: number; endAt: number; eventName: string;
src/UmamiApiClient.ts:548
↓ 1 callers
Method
getEventMetrics
( websiteId: string, params: { startAt: string; endAt: string; unit: string; t
src/UmamiApiClient.ts:324
↓ 1 callers
Method
getMyTeams
(params?: Umami.TeamSearchParams)
src/UmamiApiClient.ts:510
↓ 1 callers
Method
getMyWebsites
(params?: Umami.WebsiteSearchParams)
src/UmamiApiClient.ts:506
↓ 1 callers
Method
getRealtime
( websiteId: string, data: { startAt: number; }, )
src/UmamiApiClient.ts:518
↓ 1 callers
Method
getReport
(reportId)
src/UmamiApiClient.ts:159
↓ 1 callers
Method
getReports
( params?: Umami.SearchParams, )
src/UmamiApiClient.ts:180
↓ 1 callers
Method
getSessionActivity
( websiteId: string, sessionId: string, params: { startAt: string; endAt: string;
src/UmamiApiClient.ts:306
↓ 1 callers
Method
getSessionData
( websiteId: string, sessionId: string, )
src/UmamiApiClient.ts:317
↓ 1 callers
Method
getSessionDataProperties
( websiteId: string, params: { startAt: number; endAt: number; }, )
src/UmamiApiClient.ts:570
↓ 1 callers
Method
getSessionDataValues
( websiteId: string, params: { startAt: number; endAt: number; eventName: string;
src/UmamiApiClient.ts:580
↓ 1 callers
Method
getTeam
(teamId: string)
src/UmamiApiClient.ts:418
↓ 1 callers
Method
getTeamUser
(teamId: string, userId: string)
src/UmamiApiClient.ts:439
↓ 1 callers
Method
getTeamUsers
( teamId: string, params?: Umami.UserSearchParams, )
src/UmamiApiClient.ts:432
↓ 1 callers
Method
getTeamWebsites
( teamId: string, params?: Umami.WebsiteSearchParams, )
src/UmamiApiClient.ts:462
↓ 1 callers
Method
getTeams
( params?: Umami.TeamSearchParams, )
src/UmamiApiClient.ts:422
↓ 1 callers
Method
getUser
(userId: string)
src/UmamiApiClient.ts:110
↓ 1 callers
Method
getUserTeams
( userId: string, params?: Umami.TeamSearchParams, )
src/UmamiApiClient.ts:130
↓ 1 callers
Method
getUserUsage
( userId: string, params: { startAt: number; endAt: number; }, )
src/UmamiApiClient.ts:120
↓ 1 callers
Method
getUserWebsites
( userId: string, params?: Umami.WebsiteSearchParams, )
src/UmamiApiClient.ts:137
↓ 1 callers
Method
getWebsite
(websiteId: string)
src/UmamiApiClient.ts:202
↓ 1 callers
Method
getWebsiteEvents
( websiteId: string, params: { startAt: string; endAt: string; query?: string; }
src/UmamiApiClient.ts:246
↓ 1 callers
Method
getWebsiteReports
(websiteId: string)
src/UmamiApiClient.ts:235
↓ 1 callers
Method
getWebsiteSession
( websiteId: string, sessionId: string, )
src/UmamiApiClient.ts:299
↓ 1 callers
Method
getWebsiteSessionStats
( websiteId: string, params: { startAt: string; endAt: string; url?: string; r
src/UmamiApiClient.ts:277
↓ 1 callers
Method
getWebsiteSessions
( websiteId: string, params: { startAt: string; endAt: string; }, )
src/UmamiApiClient.ts:257
↓ 1 callers
Method
getWebsiteSessionsWeekly
( websiteId: string, params: { startAt: string; endAt: string; }, )
src/UmamiApiClient.ts:267
↓ 1 callers
Method
getWebsiteValues
( websiteId: string, params: { startAt: number; endAt: number }, )
src/UmamiApiClient.ts:239
↓ 1 callers
Method
joinTeam
(data: { accessCode: string })
src/UmamiApiClient.ts:428
↓ 1 callers
Method
resetWebsite
(websiteId: string)
src/UmamiApiClient.ts:221
↓ 1 callers
Method
runAttributionReport
(data: { websiteId: string; dateRange: { startDate: string; endDate: string }; })
src/UmamiApiClient.ts:662
↓ 1 callers
Method
runFunnelReport
(data: { websiteId: string; urls: string[]; window: number; dateRange: { startDate: stri
src/UmamiApiClient.ts:602
↓ 1 callers
Method
runGoalsReport
(data: { websiteId: string; dateRange: { startDate: string; endDate: string }; })
src/UmamiApiClient.ts:641
↓ 1 callers
Method
runInsightsReport
(data: { websiteId: string; dateRange: { startDate: string; endDate: string; }; fi
src/UmamiApiClient.ts:614
↓ 1 callers
Method
runJourneyReport
(data: { websiteId: string; dateRange: { startDate: string; endDate: string }; })
src/UmamiApiClient.ts:648
↓ 1 callers
Method
runRetentionReport
(data: { websiteId: string; dateRange: { startDate: string; endDate: string; timezone: string }; })
src/UmamiApiClient.ts:627
↓ 1 callers
Method
runRevenueReport
(data: { websiteId: string; dateRange: { startDate: string; endDate: string }; })
src/UmamiApiClient.ts:655
↓ 1 callers
Method
runUTMReport
(data: { websiteId: string; dateRange: { startDate: string; endDate: string }; })
src/UmamiApiClient.ts:634
↓ 1 callers
Method
setAuthToken
(data: object)
src/UmamiApiClient.ts:44
↓ 1 callers
Function
testGetMe
()
test.js:24
↓ 1 callers
Function
testGetWebsiteMetrics
()
test.js:34
↓ 1 callers
Function
testGetWebsitePageviews
()
test.js:49
↓ 1 callers
Function
testGetWebsites
()
test.js:14
↓ 1 callers
Function
testGetWebsitesStats
()
test.js:66
↓ 1 callers
Method
transferWebsite
( websiteId: string, params: { userId?: string; teamId?: string; }, )
src/UmamiApiClient.ts:592
↓ 1 callers
Method
updateMyPassword
(data: { currentPassword: string; newPassword: string })
src/UmamiApiClient.ts:514
↓ 1 callers
Method
updateReport
( reportId, data: { websiteId: string; type: string; name: string; description
src/UmamiApiClient.ts:163
↓ 1 callers
Method
updateTeam
( teamId: string, data: { name: string; accessCode: string; }, )
src/UmamiApiClient.ts:480
↓ 1 callers
Method
updateTeamMember
( teamId: string, userId: string, data: { role: string }, )
src/UmamiApiClient.ts:450
↓ 1 callers
Method
updateUser
( userId: string, data: { username: string; password: string }, )
src/UmamiApiClient.ts:148
↓ 1 callers
Method
updateWebsite
( websiteId: string, params: { name: string; domain: string; shareId: string; },
src/UmamiApiClient.ts:206
Method
batch
( data: { type: 'event'; payload: { data: { [key: string]: any }; hostname: st
src/UmamiApiClient.ts:688
Method
constructor
(options: UmamiApiClientOptions)
src/UmamiApiClient.ts:32
Method
deleteTeamWebsite
(teamId: string, websiteId: string)
src/UmamiApiClient.ts:476
Method
executeRoute
(url: string, method: string, data: any)
src/UmamiApiClient.ts:711
Function
getClient
(params?: { userId?: string; secret?: string; apiEndpoint?: string; apiKey?: string; })
src/client.ts:3
Method
getShare
(shareId: string)
src/UmamiApiClient.ts:155
Method
heartbeat
()
src/UmamiApiClient.ts:707
Method
login
(username: string, password: string)
src/UmamiApiClient.ts:494
Method
put
(url: string, params?: object, headers?: object)
src/UmamiApiClient.ts:85
Method
send
(data: { type: 'event'; payload: { data: { [key: string]: any }; hostname: string; l
src/UmamiApiClient.ts:669
Method
setApiEndPoint
(url: string)
src/UmamiApiClient.ts:52
Method
setSecret
(secret: string)
src/UmamiApiClient.ts:48
Method
verify
()
src/UmamiApiClient.ts:498