Authors with the default Editor role can update Owl Analytics settings, including creating and deleting Export API tokens. If you're using a custom role, you'll need to have the KB Settings custom author role permission to Update analytics settings.
The Owl Analytics Export API lets you export data from Owl Analytics for use in custom dashboards, business intelligence tools, data visualizations, and more. This feature is available on select plans.
To begin using the Owl Analytics Export API, turn on the Export API settings access and generate an access token:
- Go to KB settings > Owl Analytics.
- Under Export API, turn on the Enable toggle. This toggle is only available if Owl Analytics is already turned on.
- In the Quick start section, select Generate new API token.
- Be sure to Save your changes.
You can now start making calls to the Export API. Use Copy sample endpoint to start testing the endpoint in your browser, or copy the account export token to start crafting your own calls.
Refer to the Export API quickstart for examples to get started and the Owl Analytics Export API endpoint materials for a comprehensive list of all fields and sample output. Refer to Export API token best practices for guidance on generating, using, and rotating API tokens.