Skip to main content
GET
Retrieve workspace page analytics
Returns the Activity → Pages tab, one row per workspace page. Hidden pages are left out unless you pass filters[includeHidden]=true.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

properties
enum<string>[]

Select the numbers and nested fields to return. By default a row has only object, workspace and workspacePage, each with object, id and url; workspace.* and workspacePage.* add fields to them.

Available options:
viewsCount,
timeSpentSeconds,
lastViewedAt,
workspace.name,
workspace.workspaceUrl,
workspace.createdAt,
workspace.updatedAt,
workspacePage.name,
workspacePage.navigationName,
workspacePage.isHidden,
workspacePage.index,
workspacePage.createdAt,
workspacePage.updatedAt,
viewers.createdAt,
viewers.updatedAt,
viewers.firstName,
viewers.lastName,
viewers.avatar,
viewers.email,
viewers.name
filters
object

Filter the workspaces to report on. Without workspaceId, every workspace in the company is included.

page
integer

Page number

limit
integer

Number of results to return

Response

Retrieve the Activity tab's Pages numbers, one row per workspace page

data
object