Skip to main content
GET
/
v0
/
data-asset
/
{id}
Get a data asset by id
curl --request GET \
  --url https://{hostname}.gable.ai/v0/data-asset/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dataAssetResourceName": "<string>",
  "domain": "<string>",
  "path": "<string>",
  "type": "postgres",
  "versionDetail": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataAssetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dataAssetVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "nativeDataType": "<string>",
        "type": {},
        "displayType": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "order": 123,
        "parentFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "deletedAt": "2023-11-07T05:31:56Z",
        "piiCategory": "phone",
        "profile": {
          "sampledRecordsCount": 123,
          "nullable": true,
          "sampledFiles": [
            "<string>"
          ],
          "samplingParameters": {
            "rowSampleCount": 123,
            "recentFileCount": 123
          },
          "profileType": "boolean",
          "trueCount": 123,
          "falseCount": 123,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "nullCount": 123,
          "sampledDate": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "violations": [
      {
        "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contractVersion": "<string>",
        "contractFieldName": "<string>",
        "entityType": "DATA_CONTRACT",
        "violationType": "MISSING_REQUIRED_PROPERTY",
        "dataAssetResourceName": "<string>",
        "expectedValue": "<string>",
        "actualValue": "<string>",
        "contractName": "<string>",
        "contractDomain": "<string>",
        "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "eventType": "VIOLATION",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "prLink": "<string>"
      }
    ],
    "description": "<string>",
    "rawSchema": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "contractId": "<string>",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string<uuid>
required

UUID of the data asset

Response

Data asset

​
id
string<uuid>
required

The unique identifier for the data asset.

​
dataAssetResourceName
string
required

The unique identifier of the data asset. It follows the pattern '{data_asset_type}://{data_asset_source}:{data_asset_name}'

​
domain
string
required

The domain to which the data asset belongs. Previously referred to as "namespace."

​
path
string
required

The name or path identifying the data asset. Previously referred to as "name."

​
type
enum<string>
required

The type of the source data asset, indicating its source or format (e.g., postgres, protobuf).

Available options:
postgres,
mysql,
mssql,
json_schema,
avro,
protobuf,
python,
pyspark,
typescript,
java,
s3,
dataframe,
kotlin,
swift,
php,
golang
​
versionDetail
object
required

The version details of the data asset.

​
createdAt
string<date-time>
required

The timestamp of when the data asset was initially created.

​
updatedAt
string<date-time>
required

The timestamp of the most recent update to the data asset.

​
contractId
string

The contract ID associated with the data asset.

​
deletedAt
string<date-time>

The timestamp indicating when the data asset was deleted, if applicable.