Consumer Listing

View as Markdown

GetGET /api/2.1/marketplace-consumer/listings/{id}Batch Get ListingsGET /api/2.1/marketplace-consumer/listings:batchGetSearch Published Listings For ConsumerGET /api/2.1/marketplace-consumer/search-listings

Listing object

idstring

summaryobject

Show child attributesHide child attributes

namestring

subtitlestring

statusstring

Values: DRAFT, PENDING, PUBLISHED, SUSPENDED

shareobject

Show child attributesHide child attributes

namestring

typestring

Values: SAMPLE, FULL

provider_regionobject

Show child attributesHide child attributes

cloudstring

regionstring

settingobject

Show child attributesHide child attributes

visibilitystring

Values: PUBLIC, PRIVATE

created_atint64

created_bystring

updated_atint64

updated_bystring

published_atint64

published_bystring

categoriesarray of string

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

listingTypestring

Values: STANDARD, PERSONALIZED

created_by_idint64

updated_by_idint64

provider_idstring

exchange_idsarray of string

git_repoobject

if a git repo is being created, a listing will be initialized with this field as opposed to a share

Show child attributesHide child attributes

git_repo_urlstring

the git repo url e.g. https://github.com/databrickslabs/dolly.git

detailobject

Show child attributesHide child attributes

descriptionstring

terms_of_servicestring

documentation_linkstring

support_linkstring

file_idsarray of string

privacy_policy_linkstring

embedded_notebook_file_infosarray of object

Show child attributesHide child attributes

idstring

marketplace_file_typestring

Values: PROVIDER_ICON, EMBEDDED_NOTEBOOK, APP

file_parentobject

Show child attributesHide child attributes

parent_idstring

file_parent_typestring

Values: PROVIDER, LISTING, LISTING_RESOURCE

mime_typestring

download_linkstring

created_atint64

updated_atint64

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Values: FILE_STATUS_PUBLISHED, FILE_STATUS_STAGING, FILE_STATUS_SANITIZING, FILE_STATUS_SANITIZATION_FAILED

status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

geographical_coveragestring

Which geo region the listing data is collected from

coststring

Whether the dataset is free or paid

Values: FREE, PAID

pricing_modelstring

What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid

update_frequencyobject

How often data is updated

Show child attributesHide child attributes

intervalint64

unitstring

Values: NONE, SECOND, MINUTE, HOURLY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY

collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes

intervalint64

unitstring

Values: NONE, SECOND, MINUTE, HOURLY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY

collection_date_startint64

The starting date timestamp for when the data spans

collection_date_endint64

The ending date timestamp for when the data spans

data_sourcestring

Where/how the data is sourced

sizedouble

size of the dataset in GB

assetsarray of string

Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL, NOTEBOOK

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

licensestring

ID 20, 21 removed don't use License of the data asset - Required for listings with model based assets

tagsarray of object

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.

Show child attributesHide child attributes

tag_namestring

Tag name (enum)

Values: LISTING_TAG_TYPE_UNSPECIFIED, LISTING_TAG_TYPE_LANGUAGE, LISTING_TAG_TYPE_TASK

tag_valuesarray of string

String representation of the tag value. Values should be string literals (no complex types)

View as Markdown

The Listing object

{
  "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": [
      {}
    ]
  }
}

Get

GET /api/2.1/marketplace-consumer/listings/{id}

Get a published listing in the Databricks Marketplace that the consumer has access to.

API scopes: marketplace

Parameters

idstringpath

Response

listingobject

Show child attributesHide child attributes

idstring

summaryobject

Show child attributesHide child attributes

namestring

subtitlestring

statusstring

Values: DRAFT, PENDING, PUBLISHED, SUSPENDED

shareobject

Show child attributesHide child attributes

namestring

typestring

Values: SAMPLE, FULL

provider_regionobject

Show child attributesHide child attributes

cloudstring

regionstring

settingobject

Show child attributesHide child attributes

visibilitystring

Values: PUBLIC, PRIVATE

created_atint64

created_bystring

updated_atint64

updated_bystring

published_atint64

published_bystring

categoriesarray of string

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

listingTypestring

Values: STANDARD, PERSONALIZED

created_by_idint64

updated_by_idint64

provider_idstring

exchange_idsarray of string

git_repoobject

if a git repo is being created, a listing will be initialized with this field as opposed to a share

Show child attributesHide child attributes

git_repo_urlstring

the git repo url e.g. https://github.com/databrickslabs/dolly.git

detailobject

Show child attributesHide child attributes

descriptionstring

terms_of_servicestring

documentation_linkstring

support_linkstring

file_idsarray of string

privacy_policy_linkstring

embedded_notebook_file_infosarray of object

Show child attributesHide child attributes

idstring

marketplace_file_typestring

Values: PROVIDER_ICON, EMBEDDED_NOTEBOOK, APP

file_parentobject

mime_typestring

download_linkstring

created_atint64

updated_atint64

display_namestring

Name displayed to users for applicable files, e.g. embedded notebooks

statusstring

Values: FILE_STATUS_PUBLISHED, FILE_STATUS_STAGING, FILE_STATUS_SANITIZING, FILE_STATUS_SANITIZATION_FAILED

status_messagestring

Populated if status is in a failed state with more information on reason for the failure.

geographical_coveragestring

Which geo region the listing data is collected from

coststring

Whether the dataset is free or paid

Values: FREE, PAID

pricing_modelstring

What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid

update_frequencyobject

How often data is updated

Show child attributesHide child attributes

intervalint64

unitstring

Values: NONE, SECOND, MINUTE, HOURLY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY

collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes

intervalint64

unitstring

Values: NONE, SECOND, MINUTE, HOURLY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY

collection_date_startint64

The starting date timestamp for when the data spans

collection_date_endint64

The ending date timestamp for when the data spans

data_sourcestring

Where/how the data is sourced

sizedouble

size of the dataset in GB

assetsarray of string

Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL, NOTEBOOK

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

licensestring

ID 20, 21 removed don't use License of the data asset - Required for listings with model based assets

tagsarray of object

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.

Show child attributesHide child attributes

tag_namestring

Tag name (enum)

Values: LISTING_TAG_TYPE_UNSPECIFIED, LISTING_TAG_TYPE_LANGUAGE, LISTING_TAG_TYPE_TASK

tag_valuesarray of string

String representation of the tag value. Values should be string literals (no complex types)

View as Markdown

Response

{
  "listing": {
    "id": "string",
    "summary": {},
    "detail": {}
  }
}

Batch Get Listings

GET /api/2.1/marketplace-consumer/listings:batchGet

Batch get a published listing in the Databricks Marketplace that the consumer has access to.

API scopes: marketplace

Parameters

idsarray of stringquery

Response

Returns a list of Listing objects.

View as Markdown

Response

{
  "listings": [
    {
      "id": "string",
      "summary": {},
      "detail": {}
    }
  ]
}

Search Published Listings For Consumer

GET /api/2.1/marketplace-consumer/search-listings

Search published listings in the Databricks Marketplace that the consumer has access to. This query supports a variety of different search parameters and performs fuzzy matching.

API scopes: marketplace

Parameters

querystringquery

Fuzzy matches query

is_freebooleanquery

is_private_exchangebooleanquery

provider_idsarray of stringquery

Matches any of the following provider ids

categoriesarray of stringquery

Matches any of the following categories

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

assetsarray of stringquery

Matches any of the following asset types

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

page_tokenstringquery

page_sizeint32query

Response

Returns a list of Listing objects.

View as Markdown

Response

{
  "listings": [
    {
      "id": "string",
      "summary": {},
      "detail": {}
    }
  ],
  "next_page_token": "string"
}