ChartnautDocs

The Summary object

A Summary holds the counts from a succeeded run. It is the summary field on a Run, null until the run succeeds, and its fields depend on the run's kind. Get run results has everything the run produced.

Fields

Each field says which kinds of run carry it.

Field

Type

Description

bars

integer

Indicator: bars in the window. Definition: bars processed

outputs

object

Indicator. Keyed by output id, each {last, min, max, count}. last, min and max are null when the output has no numeric value

events_total

integer

Definition. Every event the run found

events_kept

integer

Definition. Present only when the run found more than the 10,000 it keeps

by_event

object

Definition. Events found, keyed by event id

warnings

array of string

Indicator or definition. Warnings from the run. Left out when there are none

errors

array of string

Indicator or definition. Runtime errors on some bars. The run still finished and its results are there. Left out when there are none

events_processed

integer

Study. Events the study read

source

string

Study made in the app. Always app