Get a list of datasets

Alpha: This API may change without notice; not recommended
for production use.

Returns a paginated list of datasets the caller has read access to,
optionally filtered and ordered with a CEL expression. Default page
size is 50; maximum is 100. Default ordering is by id ascending.

Set expand=true to inline reference fields (createdBy,
managedBy, storageIntegration.record, …). Without expand,
references contain only id.

Filtering and ordering with CEL

The filter and orderBy query parameters are evaluated as
Common Expression Language (CEL) expressions
against a stable schema that mirrors the dataset response body.
filter must evaluate to bool; orderBy is a CSV list of
CEL expressions whose values must be comparable. URL-encode
both; CSV-escape orderBy items first (see the orderBy
parameter for syntax).

Expressions that reference unknown fields, use the wrong type, or
exceed the server-side cost limit return 400.

CEL → REST field mapping

With the exceptions noted below, every CEL field name matches the
JSON key on Dataset-Resource 1‑to‑1, and CEL types map to JSON
wire types as follows:

CEL typeJSON wire type
string, string?string (or null when nullable)
boolboolean
intinteger
timestampRFC 3339 string (e.g. createdAt, updatedAt)
list(T)array
map(K, V)object
Wrapper typesnested object with the same sub-field names

Every id field — top-level and nested — is int in CEL but
rendered as string in JSON (int64 values may overflow the JS
number range). Compare with an integer literal in CEL:
id == 41000234, not id == "41000234".

Discrepancies between CEL and REST

FieldCELRESTNotes
_name, _packagestring, derived from labelnot presentCEL-only convenience fields. label = "Logs/AWS/CloudTrail"_package = "Logs/AWS/", _name = "CloudTrail".
createdAt, updatedAttimestampRFC 3339 stringIn CEL, compare with timestamp("2024-01-01T00:00:00Z") or use now() - duration("24h").
storageIntegration.record.*always loadable for filter evaluationonly present when expand=trueA filter like storageIntegration.record.label == "snowflake-prod" works on every request; the record object is only echoed back in the response when expand=true.

Available CEL functions

The dataset CEL environment registers the CEL standard
definitions

(operators, in, ?:, size(), string.contains, string.startsWith,
string.endsWith, matches, etc.) plus the following extension
libraries from
cel-go v0.28.0:

  • ext.StringscharAt, indexOf, join, lowerAscii, replace, split, substring, trim, upperAscii, format
  • ext.Listslists.flatten, lists.range, lists.slice
  • ext.Mathmath.greatest, math.least
  • ext.Setssets.contains, sets.equivalent, sets.intersects
  • ext.Regexre.capture, re.extract
  • ext.Encodersbase64.encode, base64.decode
  • ext.Bindingscel.bind for let-binding sub-expressions
  • ext.Protos — protobuf helpers
  • cel.OptionalTypesoptional.of, optional.ofNonZero, optional.none

See Dataset-Resource below for the full set of fields and types.

Semantic search

Pass query to find datasets by meaning rather than by exact field values.
Results are ranked by relevance descending; orderBy is ignored when
query is set. meta.totalCount is always -1 for semantic-search
requests because the full match count cannot be computed efficiently.

filter may be combined with query to narrow results after ranking.
When both are set, the response may contain fewer than limit items
if many ranked candidates are filtered out.

Returns 404 if semantic search is not available in this deployment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

CEL expression that response datasets must match. Must evaluate to
bool. Must be URL-encoded. See the operation description for the
CEL primer (field mapping, type discrepancies, available functions).

CEL functions

hasCorrelationTag(tag string, value string) bool

Returns true if this dataset has ever been associated with the
correlation tag key-value pair tag=value.

Both arguments must be constant string literals. Field references,
cel.bind names, and function calls are rejected with HTTP 400.

Error conditions:

  • HTTP 400 if a (tag, value) pair matches more than 10,000 datasets.
    Narrow the tag name or value to reduce the match set.
  • HTTP 400 if this feature is not available for your account.
    Contact support to enable correlation-tag filtering.
  • HTTP 503 if the tag index is temporarily unavailable. Retry after a short interval.
string

CSV list of CEL expressions, each producing a comparable value. Prefix an item with - for descending order. Default sort is id ascending; pagination is stable as long as no datasets are created or deleted between requests.
CSV-escape first, then URL-encode. Wrap an item in " if it contains a comma or "; double a literal " to "" inside a quoted item.
Ignored when query is set — results are ordered by relevance when semantic search is active (see the Semantic search section in the operation description).

int64

Number of items to skip before starting to collect the result set

int64

Maximum number of items to return in the response

boolean

Whether to expand resources referenced in the response to include additional fields

string
length ≤ 2000

Free-text search query. When set, returns datasets ranked by relevance to the query, with the most relevant results first. orderBy is ignored — results are always ordered by relevance descending.
May be combined with filter to narrow results after ranking, and with limit/offset for pagination. When filter is also set, the response may contain fewer than limit items if many ranked candidates are filtered out.
meta.totalCount is always -1 for semantic-search requests. Returns 404 if semantic search is not available in this deployment.

double
0 to 1
Defaults to 0.3

Minimum cosine similarity score (0.0–1.0) for semantic search results. Datasets scoring below this threshold are excluded. Only applies when query is set. Defaults to 0.3.

Responses

Language
Credentials
Bearer
Authorization: Bearer <customerid> <apitoken>
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json