Table Query

POST /table/query

Table Query

cURL

curl --request POST \
  --url https://api.example.com/table/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "digest": "<string>",
  "filter": {
    "row_digests": [
      "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims",
      "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims"
    ]
  },
  "limit": 100,
  "offset": 10,
  "sort_by": [
    {
      "field": "col_a.prop_b",
      "order": "desc"
    }
  ]
}
'

import requests

url = "https://api.example.com/table/query"

payload = {
    "project_id": "<string>",
    "digest": "<string>",
    "filter": { "row_digests": ["aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims", "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims"] },
    "limit": 100,
    "offset": 10,
    "sort_by": [
        {
            "field": "col_a.prop_b",
            "order": "desc"
        }
    ]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    digest: '<string>',
    filter: {
      row_digests: [
        'aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims',
        'aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims'
      ]
    },
    limit: 100,
    offset: 10,
    sort_by: [{field: 'col_a.prop_b', order: 'desc'}]
  })
};

fetch('https://api.example.com/table/query', 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://api.example.com/table/query",
  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([
    'project_id' => '<string>',
    'digest' => '<string>',
    'filter' => [
        'row_digests' => [
                'aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims',
                'aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims'
        ]
    ],
    'limit' => 100,
    'offset' => 10,
    'sort_by' => [
        [
                'field' => 'col_a.prop_b',
                'order' => 'desc'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/table/query"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"digest\": \"<string>\",\n  \"filter\": {\n    \"row_digests\": [\n      \"aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims\",\n      \"aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims\"\n    ]\n  },\n  \"limit\": 100,\n  \"offset\": 10,\n  \"sort_by\": [\n    {\n      \"field\": \"col_a.prop_b\",\n      \"order\": \"desc\"\n    }\n  ]\n}")

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

	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://api.example.com/table/query")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"digest\": \"<string>\",\n  \"filter\": {\n    \"row_digests\": [\n      \"aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims\",\n      \"aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims\"\n    ]\n  },\n  \"limit\": 100,\n  \"offset\": 10,\n  \"sort_by\": [\n    {\n      \"field\": \"col_a.prop_b\",\n      \"order\": \"desc\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/table/query")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"digest\": \"<string>\",\n  \"filter\": {\n    \"row_digests\": [\n      \"aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims\",\n      \"aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims\"\n    ]\n  },\n  \"limit\": 100,\n  \"offset\": 10,\n  \"sort_by\": [\n    {\n      \"field\": \"col_a.prop_b\",\n      \"order\": \"desc\"\n    }\n  ]\n}"

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

200

{
  "rows": [
    {
      "digest": "<string>",
      "val": "<unknown>",
      "original_index": 123
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Body

application/json

project_id · string · required

The ID of the project

Example:

"my_entity/my_project"

digest · string · required

The digest of the table to query

Example:

"aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims"

filter · TableRowFilter · object | null

Optional filter to apply to the query. See TableRowFilter for more details.

Show child attributes

Example:

{
  "row_digests": [
    "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims",
    "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims"
  ]
}

limit · integer | null

Maximum number of rows to return

Example:

100

offset · integer | null

Number of rows to skip before starting to return rows

Example:

10

sort_by · SortBy · object[] | null

List of fields to sort by. Fields can be dot-separated to access dictionary values. No sorting uses the default table order (insertion order).

Show child attributes

Example:

[
  { "field": "col_a.prop_b", "order": "desc" }
]

Response

200

application/json

Successful Response

rows · TableRowSchema · object[] · required

Show child attributes