Export dashboard table

post

https://export.api.exabel.com/v1/export/dashboardTable

Method for exporting one table widget of an Exabel dashboard as a data file.

The structured alternative to the SQL query the deprecated "Export data" method takes. The table is exported as the dashboard computed it: every column keeps the definition, formatting and time period it has in the app, and nothing is re-evaluated here.

The widget is named by its resource name, dashboards/1234/widgets/2. The dashboard id can be copied from the dashboard's URL in the Exabel web app; use the Management API's "List dashboard widgets" method to find the widget within it, and its "List dashboard table columns" method to find the columns of one table.

Columns are selected by identifier, by the display name shown in the table, or by position. Identifiers name a column precisely and come from the Management API; they are derived from the column's definition, so editing a column — renaming it included — gives it a new identifier. List the columns again rather than storing one between sessions.

Rows are selected by entity, by tag, or by the values in the table's own columns. Filters reach comparisons the SQL form cannot express at all: two-sided numeric ranges, exclusive bounds, relative date windows and excluded tags.

Unrecognised fields are rejected rather than ignored, at every level of the request. A misspelled filter would otherwise export more rows than were asked for, with nothing to say so.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to ExportDashboardTable.

table

string

required

The table widget to export, represented by its resource name. The widget must be a table; a chart widget is exported with the "Export chart" method instead.

columns

array of objects

length ≤ 500

The columns to export, in the order they should appear in the file. If empty, every column is exported in the order the table shows them.

The entity columns on the left of the table — the company or entity name, and for companies also MIC, ticker, FactSet id and Bloomberg ticker — are always included and cannot be selected here.

columns

tagFilter

object

Selects the entities whose rows are exported, by the tags they carry. Tags are represented by resource names, which can be copied from a tag's URL in the Exabel web app.

The three conditions are combined with AND: an entity has to satisfy every one that is given.

entities

array of strings

length ≤ 100

Limits the exported rows to these entities, represented by resource names. Combined with tagFilter as a union, matching what the web app shows: a row is exported if it matches either.

entities

columnFilters

array of objects

length ≤ 100

Filters on the values in the table's columns. A row is exported only if it passes every filter.

columnFilters

columnOrderings

array of objects

length ≤ 1

The sort order of the rows. At most one ordering is supported; giving more is an error rather than a silent choice of one of them. If empty, rows are sorted by the entity column, ascending.

columnOrderings

outputFormat

string

enum

Defaults to csv

File format to return. Matched case-insensitively. Defaults to csv.

csv
excel: .xlsx format, the only format that carries the table's own cell formatting and its sub-row grouping
json
feather
parquet

Unlike the other export methods, this one does not accept pickle, which cannot be read without executing its payload.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200The exported table, in the requested format.