Appearance

Insights ​

Insights indicate what happens on a project. Every play, export, share, and first open is logged.

List insights ​

This endpoint returns an array of the most recent insight objects for a given project, newest first. Your own activity is excluded.

Request type GET

Endpoint /projects/:projectid/insights

Query parameters ​

Use limit to control the number of insights returned. Requesting more than 100 returns 100.

/projects/:projectid/insights?limit=50

limit query parameter optional

Number of insights to return, from 1 to 100. Defaults to 25.

Insight object ​

All insight actions will return an insight object with the following structure.

Attributes ​

js
{
  boxid: string;
  city: string;
  completion: number;
  country: string;
  id: string;
  name: string;
  object: "insight";
  playerid: string;
  timeCreated: number;
  type: "play" | "export" | "share" | "first-open";
  userName: string;
}

boxid string readonly

Box id that the activity was performed on. Present on play and export insights.

city string readonly

City the activity was performed from. Not present when the location could not be resolved.

completion number readonly

Portion of the file played, in the range [0, 1]. Only present on play activities.

country string readonly

Country the activity was performed from. Not present when the location could not be resolved.

id string readonly

Insight id.

name string readonly

Name of the resource the activity was performed on.

object string readonly

Object type of returned object. Always 'insight'

playerid string readonly

Player (link) id the activity was performed through. Not present on activities that did not originate from a player.

timeCreated number readonly

When the activity was logged, in millis since Unix epoch.

type string readonly

Type of activity. 'play', 'export', 'share', or 'first-open'.

userName string readonly

Display name of the user who performed the activity. Not present for anonymous listeners, who have no display name.