Query Document

Retrieve documents from a collection via query (using v2 endpoint).

POST /api/datastores/v2/collections/{collectionId}/documents/query

Query Document

cURL

curl --request POST \
  --url https://{instance}.domo.com/api/datastores/v2/collections/{collectionId}/documents/query \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "content.userId": {
    "$eq": "123456789"
  }
}
'

import requests

url = "https://{instance}.domo.com/api/datastores/v2/collections/{collectionId}/documents/query"

payload = { "content.userId": { "$eq": "123456789" } }
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({'content.userId': {$eq: '123456789'}})
};

fetch('https://{instance}.domo.com/api/datastores/v2/collections/{collectionId}/documents/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://{instance}.domo.com/api/datastores/v2/collections/{collectionId}/documents/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([
    'content.userId' => [
        '$eq' => '123456789'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$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://{instance}.domo.com/api/datastores/v2/collections/{collectionId}/documents/query"

	payload := strings.NewReader("{\n  \"content.userId\": {\n    \"$eq\": \"123456789\"\n  }\n}")

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

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
	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://{instance}.domo.com/api/datastores/v2/collections/{collectionId}/documents/query")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content.userId\": {\n    \"$eq\": \"123456789\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/datastores/v2/collections/{collectionId}/documents/query")

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

request = Net::HTTP::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content.userId\": {\n    \"$eq\": \"123456789\"\n  }\n}"

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

Authorizations

X-DOMO-Developer-Token · string · header · required

Domo Developer Token for authentication.

Path Parameters

collectionId · string · required

The ID of the collection.

Body

application/json

A MongoDB-style query object.

{key} · object

Response

200

OK (Response body is not documented)