Website Tracking
GET
/api/v1/workspaces/{workspaceId}/tracking/analytics
Scope crm:read
Read website analytics for the workspace: page views, visitors, sessions, bounce rate, clicks, and engagement. You can filter by dimension and compare with the previous period.
Pfad
workspaceIdPflicht
string
Workspace that owns the resource.
Query
From
string (date)
From.
To
string (date)
To.
Granularity
Allowed values. day: Day. week: Week. month: Month.
Compare
boolean
Whether compare is set.
Host
string
Host.
Source
string
Source.
Device
string
Device.
Path
string
Path.
ReferrerHost
string
Referrer host.
UtmSource
string
Utm source.
UtmMedium
string
Utm medium.
UtmCampaign
string
Utm campaign.
IdentifiedOnly
boolean
Whether identified only is set.
Antworten
200TrackingWebsiteAnalyticsDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
Tracking website analytics.
installEnabled
boolean
Whether install enabled is set.
from
string (date)
From.
to
string (date)
To.
previousFrom
string (date)
Previous from.
previousTo
string (date)
Previous to.
granularity
string
Granularity.
host
string
Host.
hosts
string[]
Hosts.
summary
previousSummary
timeseries
TrackingTimeseriesBucketDto[]
Timeseries.
previousTimeseries
TrackingTimeseriesBucketDto[]
Previous timeseries.
channels
TrackingChannelStatsDto[]
Channels.
sources
TrackingSourceStatsDto[]
Sources.
pages
TrackingPageStatsDto[]
Pages.
entryPages
TrackingEntryPageStatsDto[]
Entry pages.
exitPages
TrackingExitPageStatsDto[]
Exit pages.
clickedPages
TrackingClickedPageStatsDto[]
Clicked pages.
devices
TrackingDeviceStatsDto[]
Devices.
campaigns
TrackingCampaignStatsDto[]
Campaigns.
referrers
TrackingReferrerStatsDto[]
Referrers.
links
TrackingLinkClickStatsDto[]
Links.
linkTypes
TrackingLinkTypeStatsDto[]
Link types.
activity
TrackingActivityCellDto[]
Activity.
activeMsDistribution
TrackingDistributionBucketDto[]
Active ms distribution.
scrollDistribution
TrackingDistributionBucketDto[]
Scroll distribution.
filterOptions