Skip to content
Qualia Docs

Canonical robot interfaces for the account's datasets

GET
/v1/datasets/canonical
 
curl --request GET \
  --url 'https://example.com/v1/datasets/canonical?page_size=100'

Every dataset in the caller’s account with its canonical robot interface (ADR 0008): interface_hash (the role-based unionability key) and the lens-applied canonical channels for both streams.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
account_id

Act on this account (active)

string | null format: uuid

Act on this account (active)

page_size
integer
default: 100 >= 1 <= 500
page_token
string | null
>= 2 characters <= 4162 characters /^[0-9a-f]+$/

Header Parameters

Section titled “Header Parameters ”
x-api-key
string | null

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Datasets with interface_hash + canonical channels

Media type application/json
Example generated
example

400

Section titled “400 ”

QDS data plane not enabled

401

Section titled “401 ”

Invalid or missing API key

Media type application/json
ErrorResponse

Standard error response.

object
detail
required

Error message describing what went wrong

string
Example generated
{
  "detail": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Array<object>
ValidationError
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string
input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}