Data Tables
Query Data Table
Query data tables, optionally applying a filter.
Queryable Fields
id-OBJECT_IDengagementId-OBJECT_IDanalysisId-OBJECT_IDanalysisResultId-OBJECT_IDlogicalName-STRINGtype-STRING
Permissions
api.data-tables.read
POST
Query Data Table
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Zero-based page index (0..N)
Required range:
x >= 0The size of the page to be returned
Required range:
x >= 1Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Body
application/json
- 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
Response
200 - application/json
OK
Previous
Query Data Table DataThis endpoint allows you to load data from the data table. This data is retrieved as pages and can be sorted and filtered by a
MindBridge QL query.
## 423 Locked – Response Code
MindBridge automatically loads data table results into fast storage for querying. If you receive an **HTTP 423** response code while
querying a table, it means MindBridge is retrieving your data. Wait a few seconds before trying again.
## Filter-only fields
Filter-only fields cannot be included in the `fields` or `sort` properties in a data table query, but they can be included in the `query`
property.
## Populations
If supported by your analysis, data table entries can be filtered by population, and can include an additional column to indicate all
populations that the entry appears within.
To include or exclude entries by population, use the `$population` and `$not_population` operators as part of the `query`.
For example, if you had a population with ID `"643eff00ec992f7ec42ed9f7"`, you could filter for all entries that appear within the
population.
```json
{
"query": {
"$population": "643eff00ec992f7ec42ed9f7"
},
"fields": [
"rowid",
"txid",
"debit",
"credit"
]
}
```
To include a list of populations that each entry is part of, add the `"populations"` column to the `fields` parameter.
**Note**: You cannot use the `population` field as part of a query — instead, use the `$population` and `$not_population` operators.
For example, the following body will include the `populations` column:
```json
{
"query": {},
"fields": [
"rowid",
"txid",
"populations",
"debit",
"credit"
]
}
```
### Permissions
- `api.data-tables.read`
Next
Query Data Table

