ChartnautDocs

The Forward Insight object

A Forward Insight is a study run's pin_cell answer saved to one of your definitions, so its card shows when you click that definition's events on the chart. Create a Forward Insight, Get a Forward Insight and Update a Forward Insight return one, and List Forward Insights returns a page of them.

Fields

Field

Type

Description

id

string

ins_ and a number, such as ins_842

name

string

What the chart card and the definition's Forward Insights tab show

description

string

What the card answers, or ""

definition

string

The slug of your definition whose events show the card

study

string

The slug of the study the numbers come from

study_version

integer or null

The study version that ran

instrument

string

Short symbol of the run's instrument, such as BTC. The card shows on charts of this instrument

timeframe

string

The run's timeframe. The card shows on charts of this timeframe

profile

string or null

The definition profile the run used, or null for none. The card shows where the definition is added with this profile

window

object

from and to of the study run the numbers come from

scope_dimensions

array of string

The dimensions the card is broken down by, from pin_cell's indexedBy. [] for one global card

app_url

string

Opens the study run in Chartnaut

created_at

string

When the insight was saved

updated_at

string

When it last changed

Create a Forward Insight adds a preview with the card it compiled. No other endpoint returns the card: it is built on the chart for the event you click.