--- title: "Get Data Asset" method: POST path: "/data-asset/{id}/get-item" tags: ["Data Asset"] --- # Get Data Asset `POST /data-asset/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/data-asset/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Data Asset by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` DataAssetSelectSchema: Select schema for DataAsset. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `dataStoreId` boolean - `dataStoreName` boolean - `dataStoreKind` boolean - `assetKey` boolean - `schemaName` boolean - `name` boolean - `assetKind` boolean - `description` boolean - `labels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `name` boolean - `projectId` boolean - `color` boolean - `isArchived` boolean - `rowCountChangeTolerancePercent` boolean - `freshnessColumn` boolean - `columns` boolean - `dbtNode` boolean - `columnCount` boolean - `rowCount` boolean - `sizeInBytes` boolean - `writeCredits` boolean - `writeBytesBilled` boolean - `lastChangedAt` boolean - `lastReadAt` boolean - `unreadSince` boolean - `updateIntervalInSeconds` boolean - `lastCollectedAt` boolean - `firstSeenAt` boolean - `isDropped` boolean - `droppedAt` boolean - `createdByUserId` boolean ## Response `200` Successful response - object - `data` DataAsset - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `version` number: Object version - `projectId` string, uuid, required: ID of the project this data asset belongs to. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `dataStoreId` string, uuid, required: ID of the data store this asset is in. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `dataStoreName` string: The name of the data store this asset is in. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `dataStoreKind` string: What kind of store this asset is in, such as PostgreSQL or Snowflake. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `assetKey` string, required: The asset's name with its schema, such as "public.orders": what its metrics and checks name it by. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `schemaName` string: The schema (or database, or dataset) the asset is in, such as public. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `name` string, required: The table's or view's own name, such as orders. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `assetKind` 'Table' | 'View' | 'Materialized View' | 'Partitioned Table' | 'Foreign Table' | 'Storage Path', required: Whether it is a table, a view, a materialized view, a partitioned table or a foreign table. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `description` string: What the asset holds and who relies on it, in your own words. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `labels` object[]: Labels to group and filter tables by. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `_id` string, uuid: Unique identifier for the entity - `rowCountChangeTolerancePercent` number: A change in rows this small counts as none here, raised each time such an alert is marked not an issue. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `freshnessColumn` string: A timestamp column that says when a row was written. Its latest value says when the table last changed, where the database's own counters cannot. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `columns` object: The asset's columns at its last collection: each one's name, type, whether it allows empty values, and its position. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `dbtNode` object: The dbt model, seed, snapshot or source that is this table, from the project's last uploaded artifacts: its id, materialization, tags, owner, and how its last build went. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `columnCount` number: How many columns the asset has. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `rowCount` number: How many rows the asset holds, from the engine's own statistics at the last collection. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `sizeInBytes` number: How much space the asset and its indexes take. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `writeCredits` number: Snowflake credits the jobs that write the table spent in the last day, a job's shared among the tables it writes. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `writeBytesBilled` number: BigQuery bytes billed for the jobs that write the table in the last day, a job's shared among the tables it writes. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `lastChangedAt` object: When a row was last inserted, updated or deleted, as near as the engine tells. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `lastReadAt` object: When the table was last seen read, to the hour: by the engine's read counters, or by a service's database spans. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `unreadSince` object: The time from which the table is known to have had no read: its last read, or when the engine's read counters started when it has had none since. Empty when that cannot be said. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `updateIntervalInSeconds` number: How often the asset usually changes, learned from the changes OneUptime has seen. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `lastCollectedAt` object: When OneUptime last read the asset's health. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `firstSeenAt` object: When OneUptime first found the asset. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `isDropped` boolean, required: The asset is gone from its store. It is kept with its history, and comes back if the table does. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `droppedAt` object: When OneUptime saw that the asset was gone. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `createdByUserId` string, uuid: ID of the user who created this asset, if a person did rather than OneUptime. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)