# The Listing object ## Attributes - `id` (string, Public Preview) - `summary` (object, Public Preview) - `name` (string, Public Preview) - `subtitle` (string, Public Preview) - `status` (string, Public Preview) Possible values: `DRAFT`, `PENDING`, `PUBLISHED`, `SUSPENDED` - `share` (object, Public Preview) - `name` (string, Public Preview) - `type` (string, Public Preview) Possible values: `SAMPLE`, `FULL` - `provider_region` (object, Public Preview) - `cloud` (string, Public Preview) - `region` (string, Public Preview) - `setting` (object, Public Preview) - `visibility` (string, Public Preview) Possible values: `PUBLIC`, `PRIVATE` - `created_at` (int64, Public Preview) - `created_by` (string, Public Preview) - `updated_at` (int64, Public Preview) - `updated_by` (string, Public Preview) - `published_at` (int64, Public Preview) - `published_by` (string, Public Preview) - `categories` (array of string, Public Preview) Possible values: `ADVERTISING_AND_MARKETING`, `CLIMATE_AND_ENVIRONMENT`, `COMMERCE`, `DEMOGRAPHICS`, `ECONOMICS`, `EDUCATION`, `ENERGY`, `FINANCIAL`, `GAMING`, `GEOSPATIAL`, `HEALTH`, `LOOKUP_TABLES`, `MANUFACTURING`, `MEDIA`, `OTHER`, `PUBLIC_SECTOR`, `RETAIL`, `SECURITY`, `SCIENCE_AND_RESEARCH`, `SPORTS`, `TRANSPORTATION_AND_LOGISTICS`, `TRAVEL_AND_TOURISM` - `listingType` (string, Public Preview) Possible values: `STANDARD`, `PERSONALIZED` - `created_by_id` (int64, Public Preview) - `updated_by_id` (int64, Public Preview) - `provider_id` (string, Public Preview) - `exchange_ids` (array of string, Public Preview) - `git_repo` (object, Public Preview) if a git repo is being created, a listing will be initialized with this field as opposed to a share - `git_repo_url` (string, Public Preview) the git repo url e.g. https://github.com/databrickslabs/dolly.git - `detail` (object, Public Preview) - `description` (string, Public Preview) - `terms_of_service` (string, Public Preview) - `documentation_link` (string, Public Preview) - `support_link` (string, Public Preview) - `file_ids` (array of string, Public Preview) - `privacy_policy_link` (string, Public Preview) - `embedded_notebook_file_infos` (array of object, Public Preview) - `id` (string, Public Preview) - `marketplace_file_type` (string, Public Preview) Possible values: `PROVIDER_ICON`, `EMBEDDED_NOTEBOOK`, `APP` - `file_parent` (object, Public Preview) - `parent_id` (string, Public Preview) - `file_parent_type` (string, Public Preview) Possible values: `PROVIDER`, `LISTING`, `LISTING_RESOURCE` - `mime_type` (string, Public Preview) - `download_link` (string, Public Preview) - `created_at` (int64, Public Preview) - `updated_at` (int64, Public Preview) - `display_name` (string, Public Preview) Name displayed to users for applicable files, e.g. embedded notebooks - `status` (string, Public Preview) Possible values: `FILE_STATUS_PUBLISHED`, `FILE_STATUS_STAGING`, `FILE_STATUS_SANITIZING`, `FILE_STATUS_SANITIZATION_FAILED` - `status_message` (string, Public Preview) Populated if status is in a failed state with more information on reason for the failure. - `geographical_coverage` (string, Public Preview) Which geo region the listing data is collected from - `cost` (string, Public Preview) Whether the dataset is free or paid Possible values: `FREE`, `PAID` - `pricing_model` (string, Public Preview) What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid - `update_frequency` (object, Public Preview) How often data is updated - `interval` (int64, Public Preview) - `unit` (string, Public Preview) Possible values: `NONE`, `SECOND`, `MINUTE`, `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY` - `collection_granularity` (object, Public Preview) Smallest unit of time in the dataset - `interval` (int64, Public Preview) - `unit` (string, Public Preview) Possible values: `NONE`, `SECOND`, `MINUTE`, `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY` - `collection_date_start` (int64, Public Preview) The starting date timestamp for when the data spans - `collection_date_end` (int64, Public Preview) The ending date timestamp for when the data spans - `data_source` (string, Public Preview) Where/how the data is sourced - `size` (double, Public Preview) size of the dataset in GB - `assets` (array of string, Public Preview) Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL, NOTEBOOK Possible values: `ASSET_TYPE_UNSPECIFIED`, `ASSET_TYPE_GIT_REPO`, `ASSET_TYPE_DATA_TABLE`, `ASSET_TYPE_MODEL`, `ASSET_TYPE_NOTEBOOK`, `ASSET_TYPE_MEDIA`, `ASSET_TYPE_PARTNER_INTEGRATION`, `ASSET_TYPE_APP`, `ASSET_TYPE_MCP` - `license` (string, Public Preview) ID 20, 21 removed don't use License of the data asset - Required for listings with model based assets - `tags` (array of object, Public Preview) Listing tags - Simple key value pair to annotate listings. When should I use tags vs dedicated fields? Using tags avoids the need to add new columns in the database for new annotations. However, this should be used sparingly since tags are stored as key value pair. Use tags only: 1. If the field is optional and won't need to have NOT NULL integrity check 2. The value is fairly fixed, static and low cardinality (eg. enums). 3. The value won't be used in filters or joins with other tables. - `tag_name` (string, Public Preview) Tag name (enum) Possible values: `LISTING_TAG_TYPE_UNSPECIFIED`, `LISTING_TAG_TYPE_LANGUAGE`, `LISTING_TAG_TYPE_TASK` - `tag_values` (array of string, Public Preview) String representation of the tag value. Values should be string literals (no complex types) ## Example ```json { "id": "string", "summary": { "name": "string", "subtitle": "string", "status": "string", "share": {}, "provider_region": {}, "setting": {}, "created_at": 0, "created_by": "string", "updated_at": 0, "updated_by": "string", "published_at": 0, "published_by": "string", "categories": [ "string" ], "listingType": "string", "created_by_id": 0, "updated_by_id": 0, "provider_id": "string", "exchange_ids": [ "string" ], "git_repo": {} }, "detail": { "description": "string", "terms_of_service": "string", "documentation_link": "string", "support_link": "string", "file_ids": [ "string" ], "privacy_policy_link": "string", "embedded_notebook_file_infos": [ {} ], "geographical_coverage": "string", "cost": "string", "pricing_model": "string", "update_frequency": {}, "collection_granularity": {}, "collection_date_start": 0, "collection_date_end": 0, "data_source": "string", "size": 0, "assets": [ "string" ], "license": "string", "tags": [ {} ] } } ```