HTML Environment Data API

Overview

If included in your subscription, you can access data about how viewers are consuming your demos via API endpoints curated by Reprise.

Currently, the Reprise API supports the following:

• 1 product (Reprise HTML Environment)
• 1 authentication token 
• 1 API endpoint (replay_session_activity)

API Authentication Token

1. In your portal, go to settings, then API Management and create new token:
   
   
   
   
2. Give this token a name and click create:
   
   
3. You can then now copy this token to use it:
   
   

API endpoint

After having configured your API token, you can access your API endpoint URL and parameters by clicking on the 3 dots menu, then Copy API Endpoint:

The API endpoint is structured as follows:

• Endpoint URL: base URL for the Data API endpoint
• Portal ID: unique ID of your client (a.k.a. Reprise Portal)
• Time period: period within which you will pull demo data from start date to end date
• Authentication: your generated authentication token

API Timestamp Parameters

The endpoint has two timestamp parameters: "start_timestamp" and "end_timestamp".

Here is an example to return results from July 1st to September 1st:

&start_timestamp=2022-07-01&end_timestamp=2022-08-01 

Here is an example to drill into specific date and time (replacing the 00:00:00 with a 24 hour time format will specify the time you'd like to filter by). Note that the data is in UTC timezone:

&start_timestamp=2022-07-01%2000:00:00&end_timestamp=2022-08-01%2000:00:00

Important

The API endpoint has a limit of 100MB of data. When pulling from your endpoint, consider pulling regularly from a restricted time period (e.g. a day).

Optional: Return Visitor Company Data

You can now include the company name entered by a viewer on the welcome page in your API response.

To include this field in the payload, add the following parameter to your API endpoint URL: &visitor_company=1

When enabled, the visitor_company field will appear in both the meta and data sections of the API response.

API endpoint detailed content

The replay_session_activity endpoint payload has two parts:

• Meta (contains the meta data of the payload, i.e. the field types for each return)
• Data (multiple records of the viewing activities occurring on a piece of data)

The table below details the content of the data structure in the payload:

client_id	Internal unique identifier for your account
activity_id	Internal unique identifier for this specific activity
activity_type	Human-readable description of what type of activity this datapoint is
snapshot_id	The unique identifier of which screen or snapshot is being viewed
snapshot_title	The human-readable name for each screen named in editor
guide_id	Internal unique identifier for the current guide
guide_step_number	The order of this guide in the current snapshot’s sequence of guides
guide_text	The text that appears on this guide
guide_trigger	Specifies if this guide uses “sequential” or “on hover” activation
button_text	The text that appears on this button
button_action	The action that clicking this button produced
create_at	The DateTime of the activity or event that occurs in the demo
session_id	Internal unique identifier for this specific session
visitor_name	Name entered by the user in a welcome screen
visitor_email	Email entered by the user in a welcome screen
session_created_at	The DateTime of when this specific visit to the demo
link_id	Internal unique identifier for the link used to start this session
link_title	The title that was entered when this link was created
link_description	The description that was entered when this link was created
link_url	The specific URL that was used to start this session
link_is_active	TRUE if the link still works or FALSE if the link was disabled
link_created_at	The DateTime the link was created
link_deleted_at	The DateTime the link was deleted
link_is_default	TRUE if the link is the default associated with the published demo, or FALSE if it is manually-added
link_show_welcome	TRUE if the link shows a welcome screen or FALSE if no welcome screen
link_welcome_title	The title that was entered when this welcome screen was created
link_welcome_note	The text that is shown to a visitor on the welcome screen
link_viewer_email_req	TRUE if email is required to view the demo or FALSE if email is not required
link_viewer_password_req	TRUE if a password is required to view the demo or FALSE if no password is required
published_replay_id	Internal unique identifier for this published demo
published_replay_title	The title of this published demo
published_replay_created_at	The DateTime of when this demo was published
draft_replay_id	Internal unique identifier for the draft version of this demo
draft_replay_title	The title of the draft version of this demo

Below is an example of a response payload:

{
"meta": [
{
"name": "client_id",
"type": "String"
},
{
"name": "activity_id",
"type": "String"
},
{
"name": "activity_type",
"type": "String"
},
{
"name": "snapshot_id",
"type": "String"
},
{
"name": "snapshot_title",
"type": "String"
},
{
"name": "guide_id",
"type": "String"
},
{
"name": "guide_step_number",
"type": "String"
},
{
"name": "guide_text",
"type": "String"
},
{
"name": "guide_trigger",
"type": "String"
},
{
"name": "button_text",
"type": "String"
},
{
"name": "button_action",
"type": "String"
},
{
"name": "create_at",
"type": "DateTime64(3)"
},
{
"name": "session_id",
"type": "String"
},
{
"name": "visitor_name",
"type": "String"
},
{
"name": "visitor_email",
"type": "Nullable(String)"
},
{
"name": "session_created_at",
"type": "DateTime"
},
{
"name": "link_id",
"type": "String"
},
{
"name": "link_title",
"type": "Nullable(String)"
},
{
"name": "link_description",
"type": "Nullable(String)"
},
{
"name": "link_url",
"type": "String"
},
{
"name": "link_is_active",
"type": "String"
},
{
"name": "link_created_at",
"type": "DateTime"
},
{
"name": "link_deleted_at",
"type": "Nullable(String)"
},
{
"name": "link_is_default",
"type": "String"
},
{
"name": "link_show_welcome",
"type": "String"
},
{
"name": "link_welcome_title",
"type": "String"
},
{
"name": "link_welcome_note",
"type": "String"
},
{
"name": "link_viewer_email_req",
"type": "String"
},
{
"name": "link_viewer_password_req",
"type": "String"
},
{
"name": "published_replay_id",
"type": "String"
},
{
"name": "published_replay_title",
"type": "Nullable(String)"
},
{
"name": "published_replay_created_at",
"type": "DateTime"
},
{
"name": "draft_replay_id",
"type": "String"
},
{
"name": "draft_replay_title",
"type": "String"
},
{
"name": "distinct_user",
"type": "Nullable(String)"
}
],
"data": [
{
"client_id": "b6OVwyo",
"activity_id": "X0PYL0E",
"activity_type": "new snapshot",
"snapshot_id": "[ID]",
"snapshot_title": "01. NiFi Flow",
"guide_id": "",
"guide_step_number": "",
"guide_text": "",
"guide_trigger": "",
"button_text": "",
"button_action": "",
"create_at": "2023-09-26 02:58:14.219",
"session_id": "6eGrWA1",
"visitor_name": "Anonymous (66.249.68.39)",
"visitor_email": "",
"session_created_at": "2023-09-26 02:58:14",
"link_id": "7nkV36p",
"link_title": null,
"link_description": null,
"link_url": "https://app.getreprise.com/launch/[ID]/",
"link_is_active": "True",
"link_created_at": "2021-01-25 19:59:24",
"link_deleted_at": null,
"link_is_default": "True",
"link_show_welcome": "",
"link_welcome_title": "",
"link_welcome_note": "",
"link_viewer_email_req": "",
"link_viewer_password_req": "",
"published_replay_id": "1yQb1M6",
"published_replay_title": "Tutorial 1: Using Nifi to parse COVID-19",
"published_replay_created_at": "2021-04-01 13:34:09",
"draft_replay_id": "1yQb1M6",
"draft_replay_title": "COVID API to CSV",
"distinct_user": "Anonymous (66.249.68.39)"
}
]
}

For more details, you can download this PDF.

Related to

• Analytics
• API