Ticker Docs
Tools

get_event_workspace

Get Event Workspace

Reads only.

Use this for what the caller last had open on one event's section map. Use get_event_sections instead for the section data itself. What the caller last looked at on one event's section map: the sections they had selected, which price book the chart was on (lens), the range, the metric the map was colored by, and whether the comparison was indexed to a common start (relative). An event the caller has never opened returns the empty workspace, not an error. Read-only: it never changes what they will see next time.

Parameters

NameTypeRequiredDefaultNotes
event_idstringyesThe event to read.

On this page