Get catalog
GET/v1/catalogs/:catalog_key
Get the metadata and contents of a catalog. The service account must be permitted to view the chosen catalog.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| catalog_keyrequired | path | string | The unique identifier for the catalog |
| files | query | "raw" | "resolved" | Include this parameter to request the catalog file contents. |
| definitions | query | "json" | Include this parameter to return the catalog definitions in a structured data format. |
Responses
Successful response
success * boolean
request_id * string
result * object
catalog * object — A catalog
key * string — The unique identifier for the catalog
name * string — The display name for the catalog
created_at * string (date-time) — An ISO 8601 date-time string.
description * string — A description of the catalog.
modified_at * string (date-time) | null — An ISO 8601 date-time string, or null.
permissions * object[] — The list of actors with assigned permissions for this catalog.
key * string — The unique identifier for the actor.
role * "admin" | "analyst" | "editor" | "viewer" | "reportViewer" — The assigned catalog role
type * "user" | "group" | "serviceAccount" | "workspace" — The type of actor.
sources * object[] — The connections that this catalog can access.
connection_key * string — The unique identifier for the connection
connection_name * string — The display name for the connection
agent_context string — Agent-specific context for this catalog (if any).
files object[] — The catalog files (if requested)
path * string — The file path.
contents * string — The file contents.
truncated * boolean — Whether the file contents are truncated - this can occur if the file is particularly large.
definitions object — The parsed catalog definitions (if requested).
datasets * object[] — The dataset definitions in this catalog.
name * string — The name of the dataset.
from string — The name of the view that this dataset is based on.
views object[] — The views included in this dataset.
name * string — The name of the view.
description string — A description of this dataset.
join object[] — The views joined into this dataset.
constraint * string — The join constraint expression.
relationship * "one_to_one" | "one_to_many" | "many_to_one" | "many_to_many" — The relationship cardinality.
view * string — The name of the view to join.
alias string — An alias for the joined view.
label string — A display label for the joined view.
type "inner" | "left" | "right" | "full" — The type of join.
label string — The display label for this dataset.
path string — The file path of the dataset definition.
definition_type "count" | "converted-lookml" | "extended-count" | "extended-lookml" — The origin of this definition.
sha * string | null — The commit SHA of the catalog.
views * object[] — The view definitions in this catalog.
fields * object[] — The fields in this view.
expression * string — The SQL expression for this field.
name * string — The name of the field.
type * "string" | "number" | "integer" | "boolean" | "date" — The data type of the field.
aggregates "avg" | "count" | "count_distinct" | "max" | "median" | "min" | "mode" | "stddev_pop" | "stddev_samp" | "sum" | "var_pop" | "var_samp" | null[] — The aggregate functions available for this field.
description string — A description of the field.
format unknown — The display format specification for this field.
group string — The group this field belongs to.
label string — The display label for this field.
primary_key boolean — Whether this field is a primary key.
timeframes "day_trunc" | "day_of_month" | "day_of_week" | "day_of_year" | "hour_trunc" | "hour" | "minute_trunc" | "minute" | "month_trunc" | "month" | "quarter_trunc" | "quarter" | "second_trunc" | "second" | "week_trunc" | "week" | "year_trunc" | "year" | null[] — The timeframe functions available for this field.
hidden boolean — Whether this field is hidden.
name * string — The name of the view.
source * object | object — The data source for this view.
label string — The display label for this view.
description string — A description of this view.
caching object — Caching settings for a view.
duration * number — The cache duration in seconds.
schedule string — A cron expression for the cache refresh schedule.
wait_for_cache boolean — Whether to wait for the cache to be populated before returning results.
path string — The file path of the view definition.
joins object[] — Joins to other views.
view * string — The name of the view to join.
constraint * string — The join constraint expression.
relationship * "one_to_one" | "one_to_many" | "many_to_one" | "many_to_many" — The relationship cardinality.
type "inner" | "left" | "right" | "full" — The type of join.
definition_type "count" | "converted-lookml" | "extended-count" | "extended-lookml" — The origin of this definition.
invalid boolean — Whether the catalog definitions contain validation errors.