Data Tables

Query Data Table Data

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.

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.

Paging for tables without a primary key

Some data tables, such as those loaded from a data connection, do not have a primary key. These tables are paged using a simple offset and limit rather than the optimized cursor used for other tables. As a result:

Ordering is not guaranteed to be stable across requests unless you supply a sort. Sorting on a column that contains duplicate values may still produce an inconsistent order between pages.
Requesting deep pages may be slower.

For consistent results, supply a sort on a column with unique values.

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.

{
  "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"
  ]
}

Permissions

api.data-tables.read

POST

data-tables

{dataTableId}

data

Query Data Table Data

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

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data"

payload = {
    "fields": ["<string>"],
    "query": {},
    "page": 1,
    "pageSize": 1000,
    "excludeFields": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fields: ['<string>'],
    query: {},
    page: 1,
    pageSize: 1000,
    excludeFields: ['<string>']
  })
};

fetch('https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fields' => [
        '<string>'
    ],
    'query' => [
        
    ],
    'page' => 1,
    'pageSize' => 1000,
    'excludeFields' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data"

	payload := strings.NewReader("{\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"query\": {},\n  \"page\": 1,\n  \"pageSize\": 1000,\n  \"excludeFields\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"query\": {},\n  \"page\": 1,\n  \"pageSize\": 1000,\n  \"excludeFields\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"query\": {},\n  \"page\": 1,\n  \"pageSize\": 1000,\n  \"excludeFields\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "content": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "problems": [
    {
      "problemType": "UNKNOWN",
      "severity": "WARNING",
      "entityType": "<string>",
      "entityId": "<string>",
      "identifier": "<string>",
      "values": [
        "<string>"
      ],
      "reason": "<string>",
      "suggestedValues": [
        "<string>"
      ],
      "problemCount": 123
    }
  ],
  "instance": "<string>",
  "status": 123,
  "origin": "<string>",
  "problemCount": 123,
  "entityType": "<string>",
  "entityId": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "problems": [
    {
      "problemType": "UNKNOWN",
      "severity": "WARNING",
      "entityType": "<string>",
      "entityId": "<string>",
      "identifier": "<string>",
      "values": [
        "<string>"
      ],
      "reason": "<string>",
      "suggestedValues": [
        "<string>"
      ],
      "problemCount": 123
    }
  ],
  "instance": "<string>",
  "status": 123,
  "origin": "<string>",
  "problemCount": 123,
  "entityType": "<string>",
  "entityId": "<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

page

integer<int32>

The specific page of results. This operates on a zero-based page index (0..N).

Required range: x >= 0

pageSize

integer<int32>

The number of results to be returned on each page.

Required range: 1 <= x <= 2000

sort

Data Table Query Sort Order · object

Indicates how the data will be sorted.

Default sort order = ascending

Show child attributes

excludeFields

string[]

Minimum string length: 1

Response

content

object[]

Show child attributes

⌘I

Query Data Table Data

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

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data"

payload = {
    "fields": ["<string>"],
    "query": {},
    "page": 1,
    "pageSize": 1000,
    "excludeFields": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fields: ['<string>'],
    query: {},
    page: 1,
    pageSize: 1000,
    excludeFields: ['<string>']
  })
};

fetch('https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fields' => [
        '<string>'
    ],
    'query' => [
        
    ],
    'page' => 1,
    'pageSize' => 1000,
    'excludeFields' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data"

	payload := strings.NewReader("{\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"query\": {},\n  \"page\": 1,\n  \"pageSize\": 1000,\n  \"excludeFields\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"query\": {},\n  \"page\": 1,\n  \"pageSize\": 1000,\n  \"excludeFields\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/data-tables/{dataTableId}/data")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"query\": {},\n  \"page\": 1,\n  \"pageSize\": 1000,\n  \"excludeFields\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "content": [
    {}
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "problems": [
    {
      "problemType": "UNKNOWN",
      "severity": "WARNING",
      "entityType": "<string>",
      "entityId": "<string>",
      "identifier": "<string>",
      "values": [
        "<string>"
      ],
      "reason": "<string>",
      "suggestedValues": [
        "<string>"
      ],
      "problemCount": 123
    }
  ],
  "instance": "<string>",
  "status": 123,
  "origin": "<string>",
  "problemCount": 123,
  "entityType": "<string>",
  "entityId": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "problems": [
    {
      "problemType": "UNKNOWN",
      "severity": "WARNING",
      "entityType": "<string>",
      "entityId": "<string>",
      "identifier": "<string>",
      "values": [
        "<string>"
      ],
      "reason": "<string>",
      "suggestedValues": [
        "<string>"
      ],
      "problemCount": 123
    }
  ],
  "instance": "<string>",
  "status": 123,
  "origin": "<string>",
  "problemCount": 123,
  "entityType": "<string>",
  "entityId": "<string>"
}

Overview

Details

Webhooks

API reference

Query Data Table Data

423 Locked – Response Code

Paging for tables without a primary key

Filter-only fields

Populations

Permissions

Authorizations

Path Parameters

Body

Response