Insight

Insights: run, copy, and read insight data.

Endpoints

Endpoint	Arguments	Returns
`v3.insight.copy`	`insightId: string, options: { name: string }`	unknown
`v3.insight.create`	`WorkspaceId, options`	object
`v3.insight.data`	`insightId: string, options?: { update?: boolean }`	object
`v3.insight.list`	`cid: string`	object[]
`v3.insight.member.add`	`insightId: string, permissionItem: string`	boolean
`v3.insight.member.remove`	`insightId: string, permissionItem: string`	boolean
`v3.insight.preview`	`workspaceId: string, input: { query: string, sources: InsightSource[] }`	object
`v3.insight.public`	`insightKey: string`	object
`v3.insight.query`	`workspaceId: string, input: { query: string, sources: InsightSource[] }`	object
`v3.insight.remove`	`insightId: string`	unknown
`v3.insight.update`	`insightId: string, update: object`	object

`v3.insight.copy`

Description

Copy an insight with a new name

Parameters

Argument 1 (ObjectId, required): insightId

Argument 2 (object, required):

Field	Type	Required	Description
`name`	string	no	Visible name

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.copy', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  {
    name: 'string', // Visible name
  },
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.create`

Description

Create a new insight with data sources and SQL query for analytics and reporting.

Parameters

Argument 1 (WorkspaceId, required): workspaceId (former networkId)

Argument 2 (object, optional):

Field	Type	Required	Description
`name`	string	yes	Visible name
`public`	boolean	no	Enable Insight data to be fetched via `v3.insight.public` endpoint publicly Default: `false`.
`sources`	object[]	yes	Tables in SQL See below.
`query`	string	yes	SQLite query string to work on the temporary tables built from sources

sources[] (object):

Field	Type	Required	Description
`name`	string	yes	Table name in SQL
`workflowId`	processId	yes	Workflow or Dataset Id to get activities from
`fields`	object[]	yes	Columns in SQL, set `fieldId` or `meta` as data mapping See below.
`options`	object	no	See below.

sources[].fields[] (object):

Field	Type	Required	Description
`name`	string	yes	Column name of table in SQL
`fieldId`	fieldId	no	Column source fieldId, type will depend on field type Workflow or Dataset
`phaseId`	fieldId	no	phaseId, used with meta: phaseLastMove
`meta`	string	no	Column source meta-data One of: `_id`, `uid`, `team`, `createdBy`, `name`, `created`, `updated`, `phaseId`, `phaseName`, `phaseLastMove`, `workflowId`, `workflowName`, `priority`.

sources[].options (object):

Field	Type	Required	Description
`phases`	object[]	no	Used to translate phaseIds to human readable variable names See below.

sources[].options.phases[] (object):

Field	Type	Required	Description
`name`	string	yes	Phase Id map

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.create', [
  '507f1f77bcf86cd799439011', // WorkspaceId (required)
  {
    name: 'string', // Visible name
    sources: [{
      name: 'string', // Table name in SQL
      workflowId: '507f1f77bcf86cd799439011', // Workflow or Dataset Id to get activities from
      fields: [{ /* ... */ }], // Columns in SQL, set `fieldId` or `meta` as data mapping
    }], // Tables in SQL
    query: 'string', // SQLite query string to work on the temporary tables built from sources
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
`_id`	ObjectId	yes	insightId
`hash`	binary	no
`created`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
`updated`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
`uid`	userId	yes	userId
`cid`	WorkspaceId	yes	workspaceId (former networkId)
`members`	object[]	yes	See below.
`name`	string	yes	Visible name
`description`	string	no
`public`	boolean	yes	Enable Insight data to be fetched via `v3.insight.public` endpoint publicly
`publicKey`	string	yes	Key used to access an Insight when public is set to true
`sources`	object[]	yes	Tables in SQL See below.
`query`	string	yes	SQLite query string to work on the temporary tables built from sources
`presets`	object[]	no	See below.
`workflowSuite`	object	no	See below.

members[] (object):

Field	Type	Required	Description
`id`	string	yes	`network_<networkId>`, `team_<teamId>`, `user_<userId>`, `group_<groupId>`
`info`	object	yes	Reseved
`permissions`	`edit`[]	yes

sources[] (object):

Field	Type	Required	Description
`name`	string	yes	Table name in SQL
`workflowId`	processId	yes	Workflow or Dataset Id to get activities from
`fields`	object[]	yes	Columns in SQL, set `fieldId` or `meta` as data mapping See below.
`options`	object	no	See below.

sources[].fields[] (object):

Field	Type	Required	Description
`name`	string	yes	Column name of table in SQL
`fieldId`	fieldId	no	Column source fieldId, type will depend on field type Workflow or Dataset
`phaseId`	fieldId	no	phaseId, used with meta: phaseLastMove
`meta`	string	no	Column source meta-data One of: `_id`, `uid`, `team`, `createdBy`, `name`, `created`, `updated`, `phaseId`, `phaseName`, `phaseLastMove`, `workflowId`, `workflowName`, `priority`.

sources[].options (object):

Field	Type	Required	Description
`phases`	object[]	no	Used to translate phaseIds to human readable variable names See below.

sources[].options.phases[] (object):

Field	Type	Required	Description
`name`	string	yes	Phase Id map

presets[] (object):

Field	Type	Required	Description
`version`	number	no
`name`	`default`	no
`options`	object	no	See below.

presets[].options (object):

Field	Type	Required	Description
`visibility`	any	no
`show`	any	no
`filters`	any	no
`pivot`	any	no
`table`	any	no
`drillDown`	any	no
`chart`	object	no	See below.

presets[].options.chart (object):

Field	Type	Required	Description
`type`	string	no

workflowSuite (object):

Field	Type	Required	Description
`productId`	ObjectId	yes	productId
`name`	string	yes
`packageHash`	ObjectId	yes
`created`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.data`

Description

Execute insight query and return data results for analytics visualization.

Parameters

Argument 1 (ObjectId, required): insightId

Argument 2 (Option, optional):

Field	Type	Required	Description
`update`	boolean	no	Ignore cached data, and force to rebuild

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.data', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  {
    update: false, // Ignore cached data, and force to rebuild
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
`headers`	string[]	yes
`rows`	string[][]	yes	Rows of data
`time`	timestamp	yes	Timestamp when data was last updated

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.list`

Description

List all insights in a workspace that the user has access to

Parameters

Argument 1 (WorkspaceId, required): workspaceId (former networkId)

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.list', [
  '507f1f77bcf86cd799439011', // WorkspaceId (required)
]);
console.log(result);

Returns

Array of objects:

Field	Type	Required	Description
`_id`	ObjectId	yes	insightId
`created`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
`updated`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
`uid`	userId	yes	userId
`cid`	WorkspaceId	yes	workspaceId (former networkId)
`members`	object[]	yes	See below.
`name`	string	yes	Visible name
`description`	string	no
`public`	boolean	yes	Enable Insight data to be fetched via `v3.insight.public` endpoint publicly
`publicKey`	string	yes	Key used to access an Insight when public is set to true
`sources`	object[]	yes	Tables in SQL See below.
`query`	string	yes	SQLite query string to work on the temporary tables built from sources
`presets`	object[]	no	See below.
`workflowSuite`	object	no	See below.
`hash`	any	no

members[] (object):

Field	Type	Required	Description
`id`	string	yes	`network_<networkId>`, `team_<teamId>`, `user_<userId>`, `group_<groupId>`
`info`	object	yes	Reseved
`permissions`	`edit`[]	yes

sources[] (object):

Field	Type	Required	Description
`name`	string	yes	Table name in SQL
`workflowId`	processId	yes	Workflow or Dataset Id to get activities from
`fields`	object[]	yes	Columns in SQL, set `fieldId` or `meta` as data mapping See below.
`options`	object	no	See below.

sources[].fields[] (object):

Field	Type	Required	Description
`name`	string	yes	Column name of table in SQL
`fieldId`	fieldId	no	Column source fieldId, type will depend on field type Workflow or Dataset
`phaseId`	fieldId	no	phaseId, used with meta: phaseLastMove
`meta`	string	no	Column source meta-data One of: `_id`, `uid`, `team`, `createdBy`, `name`, `created`, `updated`, `phaseId`, `phaseName`, `phaseLastMove`, `workflowId`, `workflowName`, `priority`.

sources[].options (object):

Field	Type	Required	Description
`phases`	object[]	no	Used to translate phaseIds to human readable variable names See below.

sources[].options.phases[] (object):

Field	Type	Required	Description
`name`	string	yes	Phase Id map

presets[] (object):

Field	Type	Required	Description
`version`	number	no
`name`	`default`	no
`options`	object	no	See below.

presets[].options (object):

Field	Type	Required	Description
`visibility`	any	no
`show`	any	no
`filters`	any	no
`pivot`	any	no
`table`	any	no
`drillDown`	any	no
`chart`	object	no	See below.

presets[].options.chart (object):

Field	Type	Required	Description
`type`	string	no

workflowSuite (object):

Field	Type	Required	Description
`productId`	ObjectId	yes	productId
`name`	string	yes
`packageHash`	ObjectId	yes
`created`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.member.add`

Description

Add member

Parameters

Argument 1 (ObjectId, required): insightId

Argument 2 (string, required): network_<networkId>, team_<teamId>, user_<userId>, group_<groupId>

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.member.add', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // `network_<networkId>`, `team_<teamId>`, `user_<userId>`, `group_<groupId>` (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.member.remove`

Description

Remove member of process.

Parameters

Argument 1 (ObjectId, required): insightId

Argument 2 (string, required): network_<networkId>, team_<teamId>, user_<userId>, group_<groupId>

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.member.remove', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // `network_<networkId>`, `team_<teamId>`, `user_<userId>`, `group_<groupId>` (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.preview`

Description

Preview insight query execution before saving - test data sources and SQL queries.

Parameters

Argument 1 (WorkspaceId, required): workspaceId (former networkId)

Argument 2 (object, optional):

Field	Type	Required	Description
`query`	string	yes	SQLite query string to work on the temporary tables built from sources
`sources`	object[]	yes	Tables in SQL See below.

sources[] (object):

Field	Type	Required	Description
`name`	string	yes	Table name in SQL
`workflowId`	processId	yes	Workflow or Dataset Id to get activities from
`fields`	object[]	yes	Columns in SQL, set `fieldId` or `meta` as data mapping See below.
`options`	object	no	See below.

sources[].fields[] (object):

Field	Type	Required	Description
`name`	string	yes	Column name of table in SQL
`fieldId`	fieldId	no	Column source fieldId, type will depend on field type Workflow or Dataset
`phaseId`	fieldId	no	phaseId, used with meta: phaseLastMove
`meta`	string	no	Column source meta-data One of: `_id`, `uid`, `team`, `createdBy`, `name`, `created`, `updated`, `phaseId`, `phaseName`, `phaseLastMove`, `workflowId`, `workflowName`, `priority`.

sources[].options (object):

Field	Type	Required	Description
`phases`	object[]	no	Used to translate phaseIds to human readable variable names See below.

sources[].options.phases[] (object):

Field	Type	Required	Description
`name`	string	yes	Phase Id map

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.preview', [
  '507f1f77bcf86cd799439011', // WorkspaceId (required)
  {
    query: 'string', // SQLite query string to work on the temporary tables built from sources
    sources: [{
      name: 'string', // Table name in SQL
      workflowId: '507f1f77bcf86cd799439011', // Workflow or Dataset Id to get activities from
      fields: [{ /* ... */ }], // Columns in SQL, set `fieldId` or `meta` as data mapping
    }], // Tables in SQL
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
`headers`	string[]	yes
`rows`	string[][]	yes	Rows of data
`details`	Record<string, object>	no	See below.

details.* (object):

Field	Type	Required	Description
`headers`	string[]	no	Column names
`rows`	number	yes

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.public`

Description

Get public insight data by insight key

Parameters

Argument 1 (InsightPublicKey, string, required): Key used to access an Insight when public is set to true

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.public', [
  'string', // InsightPublicKey (required)
]);
console.log(result);

Returns

Field	Type	Required	Description
`insight`	object	no	See below.
`data`	object	no	See below.

insight (object):

Field	Type	Required	Description
`name`	string	no
`presets`	object[]	no	See below.

insight.presets[] (object):

Field	Type	Required	Description
`version`	number	no
`name`	`default`	no
`options`	object	no	See below.

insight.presets[].options (object):

Field	Type	Required
`visibility`	any	no
`show`	any	no
`filters`	any	no
`pivot`	any	no
`table`	any	no
`drillDown`	any	no
`chart`	object	no

data (object):

Field	Type	Required	Description
`headers`	string[]	yes
`rows`	string[][]	yes	Rows of data
`time`	timestamp	yes	Timestamp when data was last updated

Auth: callable without authentication.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.query`

Description

Execute a full insight query without saving. Returns all rows with no row-count cap. Not metered.

Parameters

Argument 1 (WorkspaceId, required): workspaceId (former networkId)

Argument 2 (object, required):

Field	Type	Required	Description
`query`	string	yes	SQLite query string to work on the temporary tables built from sources
`sources`	object[]	yes	Tables in SQL See below.

sources[] (object):

Field	Type	Required	Description
`name`	string	yes	Table name in SQL
`workflowId`	processId	yes	Workflow or Dataset Id to get activities from
`fields`	object[]	yes	Columns in SQL, set `fieldId` or `meta` as data mapping See below.
`options`	object	no	See below.

sources[].fields[] (object):

Field	Type	Required	Description
`name`	string	yes	Column name of table in SQL
`fieldId`	fieldId	no	Column source fieldId, type will depend on field type Workflow or Dataset
`phaseId`	fieldId	no	phaseId, used with meta: phaseLastMove
`meta`	string	no	Column source meta-data One of: `_id`, `uid`, `team`, `createdBy`, `name`, `created`, `updated`, `phaseId`, `phaseName`, `phaseLastMove`, `workflowId`, `workflowName`, `priority`.

sources[].options (object):

Field	Type	Required	Description
`phases`	object[]	no	Used to translate phaseIds to human readable variable names See below.

sources[].options.phases[] (object):

Field	Type	Required	Description
`name`	string	yes	Phase Id map

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.query', [
  '507f1f77bcf86cd799439011', // WorkspaceId (required)
  {
    query: 'string', // SQLite query string to work on the temporary tables built from sources
    sources: [{
      name: 'string', // Table name in SQL
      workflowId: '507f1f77bcf86cd799439011', // Workflow or Dataset Id to get activities from
      fields: [{ /* ... */ }], // Columns in SQL, set `fieldId` or `meta` as data mapping
    }], // Tables in SQL
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
`headers`	string[]	yes
`rows`	string[][]	yes	Rows of data
`details`	Record<string, object>	no	See below.

details.* (object):

Field	Type	Required	Description
`headers`	string[]	no	Column names
`rows`	number	yes

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.remove`

Description

Remove an insight

Parameters

Argument 1 (ObjectId, required): insightId

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.remove', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

`v3.insight.update`

Description

Update an existing insight

Parameters

Argument 1 (ObjectId, required): insightId

Argument 2 (object, required):

Field	Type	Required	Description
`name`	string	no	Visible name
`public`	boolean	no	Enable Insight data to be fetched via `v3.insight.public` endpoint publicly
`sources`	object[]	no	Tables in SQL See below.
`query`	string	no	SQLite query string to work on the temporary tables built from sources
`presets`	object[]	no	See below.

sources[] (object):

Field	Type	Required	Description
`name`	string	yes	Table name in SQL
`workflowId`	processId	yes	Workflow or Dataset Id to get activities from
`fields`	object[]	yes	Columns in SQL, set `fieldId` or `meta` as data mapping See below.
`options`	object	no	See below.

sources[].fields[] (object):

Field	Type	Required	Description
`name`	string	yes	Column name of table in SQL
`fieldId`	fieldId	no	Column source fieldId, type will depend on field type Workflow or Dataset
`phaseId`	fieldId	no	phaseId, used with meta: phaseLastMove
`meta`	string	no	Column source meta-data One of: `_id`, `uid`, `team`, `createdBy`, `name`, `created`, `updated`, `phaseId`, `phaseName`, `phaseLastMove`, `workflowId`, `workflowName`, `priority`.

sources[].options (object):

Field	Type	Required	Description
`phases`	object[]	no	Used to translate phaseIds to human readable variable names See below.

sources[].options.phases[] (object):

Field	Type	Required	Description
`name`	string	yes	Phase Id map

presets[] (object):

Field	Type	Required	Description
`version`	number	no
`name`	`default`	no
`options`	object	no	See below.

presets[].options (object):

Field	Type	Required	Description
`visibility`	any	no
`show`	any	no
`filters`	any	no
`pivot`	any	no
`table`	any	no
`drillDown`	any	no
`chart`	object	no	See below.

presets[].options.chart (object):

Field	Type	Required	Description
`type`	string	no

Example

javascript

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('v3.insight.update', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  {
    name: 'string', // Visible name
    public: false, // Enable Insight data to be fetched via `v3.insight.public` endpoint publicly
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
`_id`	ObjectId	yes	insightId
`hash`	binary	no
`created`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
`updated`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)
`uid`	userId	yes	userId
`cid`	WorkspaceId	yes	workspaceId (former networkId)
`members`	object[]	yes	See below.
`name`	string	yes	Visible name
`description`	string	no
`public`	boolean	yes	Enable Insight data to be fetched via `v3.insight.public` endpoint publicly
`publicKey`	string	yes	Key used to access an Insight when public is set to true
`sources`	object[]	yes	Tables in SQL See below.
`query`	string	yes	SQLite query string to work on the temporary tables built from sources
`presets`	object[]	no	See below.
`workflowSuite`	object	no	See below.

members[] (object):

Field	Type	Required	Description
`id`	string	yes	`network_<networkId>`, `team_<teamId>`, `user_<userId>`, `group_<groupId>`
`info`	object	yes	Reseved
`permissions`	`edit`[]	yes

sources[] (object):

Field	Type	Required	Description
`name`	string	yes	Table name in SQL
`workflowId`	processId	yes	Workflow or Dataset Id to get activities from
`fields`	object[]	yes	Columns in SQL, set `fieldId` or `meta` as data mapping See below.
`options`	object	no	See below.

sources[].fields[] (object):

Field	Type	Required	Description
`name`	string	yes	Column name of table in SQL
`fieldId`	fieldId	no	Column source fieldId, type will depend on field type Workflow or Dataset
`phaseId`	fieldId	no	phaseId, used with meta: phaseLastMove
`meta`	string	no	Column source meta-data One of: `_id`, `uid`, `team`, `createdBy`, `name`, `created`, `updated`, `phaseId`, `phaseName`, `phaseLastMove`, `workflowId`, `workflowName`, `priority`.

sources[].options (object):

Field	Type	Required	Description
`phases`	object[]	no	Used to translate phaseIds to human readable variable names See below.

sources[].options.phases[] (object):

Field	Type	Required	Description
`name`	string	yes	Phase Id map

presets[] (object):

Field	Type	Required	Description
`version`	number	no
`name`	`default`	no
`options`	object	no	See below.

presets[].options (object):

Field	Type	Required	Description
`visibility`	any	no
`show`	any	no
`filters`	any	no
`pivot`	any	no
`table`	any	no
`drillDown`	any	no
`chart`	object	no	See below.

presets[].options.chart (object):

Field	Type	Required	Description
`type`	string	no

workflowSuite (object):

Field	Type	Required	Description
`productId`	ObjectId	yes	productId
`name`	string	yes
`packageHash`	ObjectId	yes
`created`	timestamp	yes	Time (milliseconds since 1970-01-01 UTC)

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, retryAfter?, debug? }. retryAfter is a delay in milliseconds.

Endpoints

Legacy

V2

V3

Insight

Endpoints

`v3.insight.copy`

`v3.insight.create`

`v3.insight.data`

`v3.insight.list`

`v3.insight.member.add`

`v3.insight.member.remove`

`v3.insight.preview`

`v3.insight.public`

`v3.insight.query`

`v3.insight.remove`

`v3.insight.update`

Legacy

V2

V3

Insight ​

Endpoints ​

v3.insight.copy ​

v3.insight.create ​

v3.insight.data ​

v3.insight.list ​

v3.insight.member.add ​

v3.insight.member.remove ​

v3.insight.preview ​

v3.insight.public ​

v3.insight.query ​

v3.insight.remove ​

v3.insight.update ​

Insight

Endpoints

`v3.insight.copy`

`v3.insight.create`

`v3.insight.data`

`v3.insight.list`

`v3.insight.member.add`

`v3.insight.member.remove`

`v3.insight.preview`

`v3.insight.public`

`v3.insight.query`

`v3.insight.remove`

`v3.insight.update`