Clone 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 Clone Environment)
• 1 authentication token 
• 1 API endpoint (API_Clone Environment_Analytics)

API Authentication Token

Reach out to your CSM to receive your Clone Environment token. 

API endpoint

After having configured your API token, you can access your API endpoint URL and parameters by copying the API Endpoint below: 

https://api.us-east.tinybird.co/v0/pipes/api_replicate_analytics.json?token=<your_token_here>&start_timestamp=2020-01-01 01:01:01&end_timestamp=2020-01-31 23:59:59

The API endpoint is structured as follows:

• Endpoint URL: base URL for the Data API endpoint
• Authentication: your generated authentication token
• Time period: period within which you will pull demo data from start date to end date

API Timestamp Parameters

The endpoint has two timestamp parameters: "start_timestamp" and "end_timestamp".  The start timestamp is required, but the end timestamp is optional and can be left off to pull sessions through the current time.

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):

&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).

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:

shard_name	Internal identifier for infrastructure shard
client_id	Internal unique identifier for your account
demo_title	Title of the demo viewed in this session
demo_published_date	Date the demo was (re)published
session_date	Date the demo was viewed by the viewer
viewer	Viewer information; the email address if a Welcome Screen is used, or the IP address if not

Below is an example of a response payload:

{
	"meta":
	[
		{
			"name": "shard_name",
			"type": "String"
		},
		{
			"name": "client_id",
			"type": "String"
		},
		{
			"name": "demo_title",
			"type": "String"
		},
		{
			"name": "demo_published_date",
			"type": "DateTime64(3)"
		},
		{
			"name": "session_date",
			"type": "DateTime64(3)"
		},
		{
			"name": "viewer",
			"type": "String"
		}
	],

	"data":
	[
		{
			"shard_name": "app",
			"client_id": "abc123",
			"demo_title": "Your Demo's Title",
			"demo_published_date": "2024-09-23 22:24:33.837",
			"session_date": "2024-09-23 23:12:56.562",
			"viewer": "[e-mail]"
		}
	],

	"rows": 1,

	"statistics":
	{
		"elapsed": 0.163560973,
		"rows_read": 288052,
		"bytes_read": 33756466
	}
}

For more details, you can download this PDF.

Related to

• Replicate
• API