Export Data Table
Export a data table as a CSV. Exporting returns an async result, which can then be used to return a file result.
CSV Formatting
By default, the following CSV formatting is used:
- Comma (
,) is used as the separator - Double quotes (
") are used as the quote character - Double quotes (
") are used as the quote escape character: ("") - No quote escape escape value is set, as it is not needed
- All headers and values are quoted
The CSV formatting rules can be customized by setting the csvConfiguration field. Any values that are not changed will use their
default value.
It is strongly recommended to not use newline or whitespace characters, or to use the same characters for both the separator and quote characters, as they may produce files that can’t be read correctly.
Inner lists
ARRAY_STRINGS type fields are formatted as a CSV value.
By default, they have the following formatting:
- Semicolon (
;) is used as the separator - Single quotes (
') are used as the quote character - Single quotes (
') are used as the quote escape character: ('') - No quote escape escape value is set, as it is not needed
- All values are quoted
In addition to the same recommendations as with CSV formatting it is also strongly recommended to not use the same characters for formatting inner lists as are used for CSV formatting, as it may produce a file that can’t be read correctly.
Flag type formatting
BOOLEAN_FLAGS, MAP_SCALARS, and LEGACY_ACCOUNT_TAG_EFFECTS type fields are split into multiple columns based on the column’s flags.
The field names will be formatted in the following way: {field}_{flag}.
Query Restrictions
Columns with type KEYWORD_SEARCH or the filterOnly property set to true can’t be included in data table exports. Attempting to select them as part of
fields will cause the export request to fail.
Sorting Restrictions
When a sort is provided in the request body, it will only apply to data table exports under 2 million rows. For exports over 2 million
rows, no sorting will be applied to improve performance.
Permissions
api.data-tables.read
Documentation Index
Fetch the complete documentation index at: https://developer.mindbridge.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
The data table fields to be included in the results.
The MindBridge QL query used to filter data in the data table.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
Indicates how the data will be sorted.
Default sort order = ascending
The number of results to be returned.
x >= 1The configuration to use when generating the CSV file.
The configuration to use when formatting lists within cells in the CSV file.
Response
OK
Indicates the data integrity version to ensure data consistency.
The unique object identifier.
The date that the object was originally created.
The date that the object was last updated or modified.
Details about the user who created the object.
Details about the user who last modified or updated the object.
Indicates the type of job being run.
ANALYSIS_RUN, ANALYSIS_SOURCE_INGESTION, ADMIN_REPORT, DATA_TABLE_EXPORT, ANALYSIS_ROLL_FORWARD, GDPDU_UNPACK_JOB, ACCOUNT_GROUPING_EXPORT, ACCOUNT_MAPPING_EXPORT, DATA_TRANSFORMATION_JOB, CONNECTION_TEST, CONNECTION_TABLES, DATA_TABLE Indicates the current state of the job.
IN_PROGRESS, COMPLETE, ERROR Identifies the entity used in the job.
Identifies the entity type used in the job.
ORGANIZATION, ENGAGEMENT, ANALYSIS, ANALYSIS_RESULT, ANALYSIS_SOURCE, FILE_RESULT, GDPDU_UNPACK_JOB, ACCOUNT_GROUPING, ENGAGEMENT_ACCOUNT_GROUPING, FILE_MANAGER_FILE, CONNECTION_TEST_RESULT, CONNECTION_TABLES_RESULT, DATA_TABLE The reason why the async job failed.