Data Tables

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

POST

data-tables

{dataTableId}

export

Export Data Table

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": [
    "<string>"
  ],
  "query": {},
  "limit": 2
}
'

{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "entityId": "<string>",
  "error": "<string>",
  "errorMessage": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dataTableId

string

required

Body

application/json

fields

string[]

required

The data table fields to be included in the results.

Minimum array length: 1

Minimum string length: 1

query

object

The MindBridge QL query used to filter data in the data table.

Show child attributes

sort

Data Table Query Sort Order · object

Indicates how the data will be sorted.

Default sort order = ascending

Show child attributes

limit

integer<int32>

The number of results to be returned.

Required range: x >= 1

csvConfiguration

CSV Configuration · object

The configuration to use when generating the CSV file.

Show child attributes

innerListCsvConfiguration

CSV Configuration · object

The configuration to use when formatting lists within cells in the CSV file.

Show child attributes

Response

string

The unique object identifier.

version

integer<int64>

Indicates the data integrity version to ensure data consistency.

creationDate

string<date-time>

The date that the object was originally created.

lastModifiedDate

string<date-time>

The date that the object was last updated or modified.

createdUserInfo

User Info · object

read-only

Details about the user who created the object.

Show child attributes

lastModifiedUserInfo

User Info · object

read-only

Details about the user who last modified or updated the object.

Show child attributes

type

enum<string>

Indicates the type of job being run.

Available options:

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

status

enum<string>

Indicates the current state of the job.

Available options:

IN_PROGRESS,

COMPLETE,

ERROR

entityId

string

Identifies the entity used in the job.

entityType

enum<string>

Identifies the entity type used in the job.

Available options:

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

error

string

The reason why the async job failed.

errorMessage

string

Query Data TableQuery data tables, optionally applying a filter. ### Queryable Fields - `id` - `OBJECT_ID` - `engagementId` - `OBJECT_ID` - `analysisId` - `OBJECT_ID` - `analysisResultId` - `OBJECT_ID` - `logicalName` - `STRING` - `type` - `STRING` ### Permissions - `api.data-tables.read`

⌘I

Export Data Table

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": [
    "<string>"
  ],
  "query": {},
  "limit": 2
}
'

{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "entityId": "<string>",
  "error": "<string>",
  "errorMessage": "<string>"
}