Skip to main content
GET
ListColumnUsage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

entityId
string

The synq path of the table, view or model to list the column usage of, as ListJoinPatternsRequest.entity_id takes it.

Required string length: 1 - 4096
column
string

Set to return only the usage of this column of the entity. Matched case-insensitively. Leave empty for every column.

Maximum string length: 4096
queryLog.from.seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -315576000000 and 315576000000 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).

queryLog.from.nanos
integer<int32>

Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

queryLog.minQueries

A pattern seen only in the query history is listed when it reaches any of these thresholds that is set. 0 sets none, and with none set every pattern is listed. A pattern that a SQL definition makes is always listed.

queryLog.minLogins
integer
queryLog.includeCoalesceQuality
boolean

Set to keep the queries Coalesce ran, as JoinQueryLogRequest does.

queryLog.excludeServiceAccounts
boolean

Set to leave out the queries of every warehouse user in a service account, and count them in query_log_left_out.

queryLog.includeChecks
boolean

Set to keep the queries that check a table rather than use it: a dbt test, a dbt source freshness check, or a query of the Elementary package. Leave unset to leave them out and count them in query_log_left_out, as a check filters a column to assert, not to slice.

Response

200 - application/json

Success

ListColumnUsageResponse lists the column usage of the requested entity.

patterns
ColumnUsagePattern · object[]

The usage patterns. Those that a SQL definition makes come first, then those of the query history only, by distinct logins and queries.

queryLogCoveredHours
integer

How many hours of the query_log window the query history covered in full. 0 with no QUERY_LOG pattern means that no query history was read for the window, not that no query used a column.

queryLogLeftOut
ColumnUsageQueryLogLeftOut · object

The queries left out of the query history evidence. Set when the request sets query_log.

entityIds
string[]

The requested entity first, then every entity that is the same object. The patterns already include the usage of each of them.

Maximum string length: 4096