This 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.
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 cannot be included in the fields or sort properties in a data table query, but they can be included in the query
property.
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.
{
"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:
{
"query": {},
"fields": [
"rowid",
"txid",
"populations",
"debit",
"credit"
]
}
api.data-tables.readBearer authentication header of the form Bearer <token>, where <token> is your auth token.
The data table fields to be included in the results.
1\s*\S+.*The MindBridge QL query used to filter data in the data table.
The specific page of results. This operates on a zero-based page index (0..N).
x >= 0The number of results to be returned on each page.
1 <= x <= 100Indicates how the data will be sorted.
Default sort order = ascending
1\s*\S+.*OK