Skip to main content

Accessing Analytics

  • Head over to the Publish tab on the left bar of the editor.
  • Click on Analytics inside the deployment section on the top right of the deployment card.


Analytics Page

Once you are on the analytics page, you shall find various sections on the page, that will show you a detailed analysis of your deployment.

Analytics Page

Forward analytics to an external endpoint

You can configure live viewer state information to be forwarded to an external API.

  • To do so, head over to the Settings page by clicking on your avatar on the top right of the page.
  • On Settings page, scroll down to the Advanced section and expand it.
  • Clicking on the ENABLE VIEWER STATE FORWARDING will reveal the following.

Viewer State Forwarding

  • An API secret will be created for your organization. This can be used to validate source identity by you.
  • Enter an API endpoint for us to send requests to.

What will we send?

Every time there is an update to any viewer state (variables) in the organization (for all projects), the updated viewer state will be sent to the external endpoint. One possible use of this is to keep a database at your end updated with the progress of viewers across your experiences.

  1. Type of request:
  • POST
  1. Header:
  • authorization: JWT token created using shared API secret and identifier
  1. Body:
organization_slugThe slug of your organization
deployment_slugThe slug of the deployment that the viewer visited
...There might be more variables depending on viewer information.
  • deployment_slug is the link of the deployment specified in the publish page.
  • organization_slug is the last part of the URL you see on your portal page (abcxyz in when you login to the portal.