Tools
list_screen_columns
Lists every column a screen or a View can name, with its meaning, its unit and the plan that includes it.
When to use it
- Before you write a predicate for
screen_events,create_vieworupdate_view. Name columns exactly as this list spells them. - To choose the
columnsascreen_eventsrow carries. - To see the preset screens and run one by its key:
viewpresets. - For the values of these columns on one event, use
get_event_analytics.
Inputs
offset(integer): Skip this many columns. The catalog comes back in parts: when an answer is cut,meta.nextgives the offset for the next part. Leave it out for the first part.search(string or array of strings): One or more words, as one string likeprice demandor a list like["price", "demand"]: only the columns whose name, group or meaning contains one of them. Leave it out for the whole catalog.view(string, defaultcolumns):columns(the default): the columns.presets: the preset screens instead, each with its key, name, predicate, sort, the columns it shows, the plan its filter needs and whether your plan holds it. Pass a key toscreen_eventsaspresetto run it. One ofcolumns,presets.
Examples
What can I screen events on?
{}Show me the rest of the column list.
{ "offset": 83 }What comes back
- The catalog in parts: the first part is the start of the list. A cut part comes back as
datawithmeta.truncated,meta.returned_rows,meta.total_rowsandmeta.next, the offset to call with for the next part. - One row per column:
namespace,column_name,data_type,label,unitanddescription, which says what the column means and when it is empty. - The namespaces:
eaholds the event's market numbers,ethe event's own facts like its dates,pathe performer's numbers,pthe performer's name, andvthe venue's name, place and capacity. - In a predicate, name a column as
namespace.column_name, likeea.median_price_pct_7d, never by its label. enum_valueslists the allowed values of a column that takes a fixed set.lockedistruefor a column your plan does not include, withrequired_tier, the plan that includes it. A locked column stays on the list so you can see what a plan adds.
Limits and quota
- Reads only: it changes nothing.
- Free: it spends no quota.
- The whole catalog takes a few calls. Read it once and keep it.