Skip to main content
GET
/
api
/
v1
/
projects
/
{projectUuid}
/
dataCatalog
Error
A valid request URL is required to generate request examples
{
  "results": [
    {
      "name": "<string>",
      "label": "<string>",
      "fieldType": "metric",
      "tableLabel": "<string>",
      "owner": {
        "email": "<string>",
        "lastName": "<string>",
        "firstName": "<string>",
        "userUuid": "<string>"
      },
      "aiHints": [
        "<string>"
      ],
      "icon": {
        "unicode": "<string>"
      },
      "categories": [
        {
          "name": "<string>",
          "color": "<string>",
          "tagUuid": "<string>",
          "yamlReference": "<string>"
        }
      ],
      "tableName": "<string>",
      "fieldValueType": "percentile",
      "basicType": "string",
      "type": "field",
      "catalogSearchUuid": "<string>",
      "description": "<string>",
      "requiredAttributes": {},
      "anyAttributes": {},
      "spotlightSegmentBy": [
        "<string>"
      ],
      "spotlightFilterBy": [
        "<string>"
      ],
      "searchRank": 123,
      "chartUsage": 123,
      "tags": [
        "<string>"
      ],
      "tableGroupLabel": "<string>"
    }
  ],
  "status": "ok"
}

Documentation Index

Fetch the complete documentation index at: https://lightdash-docs-okta-cloud-sso-setup.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

ā€‹
projectUuid
string
required

Query Parameters

ā€‹
search
string
ā€‹
type
enum<string>
Available options:
table,
field
ā€‹
filter
enum<string>
Available options:
tables,
dimensions,
metrics

Response

Success

ā€‹
results
object[]
required

From T, pick a set of properties whose keys are in the union K

ā€‹
status
enum<string>
required
Available options:
ok