Site insights
Analyze traffic and engagement metrics for your docs site.
This API delivers insights about how visitors interact with your site, including page views and user engagement, helping you measure and optimize your content strategy.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$siteIdstringRequired
The unique id of the site
Body
Responses
204
Events have been tracked.
post/orgs/{organizationId}/sites/{siteId}/insights/events
204
Events have been tracked.
No content
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$siteIdstringRequired
The unique id of the site
Body
rangeone ofRequired
string · enumOptionalPossible values:
limitinteger · min: 1 · max: 1000OptionalDefault:
1000Responses
200
Aggregated events in the site.
application/json
post/orgs/{organizationId}/sites/{siteId}/insights/events/aggregate
200
Aggregated events in the site.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$siteIdstringRequired
The unique id of the site
Responses
200
List of visitor segments in the site.
application/json
countnumberOptional
Total count of objects in the list
get/orgs/{organizationId}/sites/{siteId}/insights/visitor-segments
200
List of visitor segments in the site.
Last updated
Was this helpful?