Provider

View as Markdown

Get a listingGET /api/2.0/marketplace-provider/listings/{id}List listingsGET /api/2.0/marketplace-provider/listingsCreate a listingPOST /api/2.0/marketplace-provider/listingUpdate listingPUT /api/2.0/marketplace-provider/listings/{id}Delete a listingDELETE /api/2.0/marketplace-provider/listings/{id}Get providerGET /api/2.0/marketplace-provider/providers/{id}List providersGET /api/2.0/marketplace-provider/providersCreate a providerPOST /api/2.0/marketplace-provider/providerUpdate providerPUT /api/2.0/marketplace-provider/providers/{id}Delete providerDELETE /api/2.0/marketplace-provider/providers/{id}All personalization requests across all listingsGET /api/2.0/marketplace-provider/personalization-requestsUpdate personalization request statusPUT /api/2.0/marketplace-provider/listings/{listing_id}/personalization-requests/{request_id}/request-statusGet a fileGET /api/2.0/marketplace-provider/files/{file_id}List filesGET /api/2.0/marketplace-provider/filesCreate a filePOST /api/2.0/marketplace-provider/filesDelete a fileDELETE /api/2.0/marketplace-provider/files/{file_id}Get provider analytics dashboardGET /api/2.0/marketplace-provider/analytics_dashboardCreate provider analytics dashboardPOST /api/2.0/marketplace-provider/analytics_dashboardUpdate provider analytics dashboardPUT /api/2.0/marketplace-provider/analytics_dashboard/{id}Get latest version of provider analytics dashboardGET /api/2.0/marketplace-provider/analytics_dashboard/latest

Listing object

idstringPublic Preview

summaryobjectPublic Preview

Show child attributesHide child attributes

namestringPublic Preview

subtitlestringPublic Preview

statusstringPublic Preview

Enums

Values:

• DRAFT
• PENDING
• PUBLISHED
• SUSPENDED

shareobjectPublic Preview

Show child attributesHide child attributes

namestringPublic Preview

typestringPublic Preview

Values:

• SAMPLE
• FULL

provider_regionobjectPublic Preview

Show child attributesHide child attributes

cloudstringPublic Preview

regionstringPublic Preview

settingobjectPublic Preview

Show child attributesHide child attributes

visibilitystringPublic Preview

Values:

• PUBLIC
• PRIVATE

created_atint64Public Preview

created_bystringPublic Preview

updated_atint64Public Preview

updated_bystringPublic Preview

published_atint64Public Preview

published_bystringPublic Preview

categoriesarray of stringPublic Preview

Values:

Show 22 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

listingTypestringPublic Preview

Values:

• STANDARD
• PERSONALIZED

created_by_idint64Public Preview

updated_by_idint64Public Preview

provider_idstringPublic Preview

exchange_idsarray of stringPublic Preview

git_repoobjectPublic Preview

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_urlstringPublic Preview

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

detailobjectPublic Preview

Show child attributesHide child attributes

descriptionstringPublic Preview

terms_of_servicestringPublic Preview

documentation_linkstringPublic Preview

support_linkstringPublic Preview

file_idsarray of stringPublic Preview

privacy_policy_linkstringPublic Preview

embedded_notebook_file_infosarray of objectPublic Preview

Show child attributesHide child attributes

idstringPublic Preview

marketplace_file_typestringPublic Preview

Values:

• PROVIDER_ICON
• EMBEDDED_NOTEBOOK
• APP

file_parentobjectPublic Preview

Show child attributesHide child attributes

parent_idstringPublic Preview

file_parent_typestringPublic Preview

Values:

• PROVIDER
• LISTING
• LISTING_RESOURCE

mime_typestringPublic Preview

download_linkstringPublic Preview

created_atint64Public Preview

updated_atint64Public Preview

display_namestringPublic Preview

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

statusstringPublic Preview

Values:

• FILE_STATUS_PUBLISHED
• FILE_STATUS_STAGING
• FILE_STATUS_SANITIZING
• FILE_STATUS_SANITIZATION_FAILED

status_messagestringPublic Preview

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

geographical_coveragestringPublic Preview

Which geo region the listing data is collected from

coststringPublic Preview

Whether the dataset is free or paid

Values:

• FREE
• PAID

pricing_modelstringPublic Preview

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

update_frequencyobjectPublic Preview

How often data is updated

Show child attributesHide child attributes

intervalint64Public Preview

unitstringPublic Preview

Values:

• NONE
• SECOND
• MINUTE
• HOURLY
• DAILY
• WEEKLY
• MONTHLY
• QUARTERLY
• YEARLY

collection_granularityobjectPublic Preview

Smallest unit of time in the dataset

Show child attributesHide child attributes

intervalint64Public Preview

unitstringPublic Preview

Values:

• NONE
• SECOND
• MINUTE
• HOURLY
• DAILY
• WEEKLY
• MONTHLY
• QUARTERLY
• YEARLY

collection_date_startint64Public Preview

The starting date timestamp for when the data spans

collection_date_endint64Public Preview

The ending date timestamp for when the data spans

data_sourcestringPublic Preview

Where/how the data is sourced

sizedoublePublic Preview

size of the dataset in GB

assetsarray of stringPublic Preview

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

licensestringPublic Preview

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

tagsarray of objectPublic 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.

Show child attributesHide child attributes

tag_namestringPublic Preview

Tag name (enum)

Values:

• LISTING_TAG_TYPE_UNSPECIFIED
• LISTING_TAG_TYPE_LANGUAGE
• LISTING_TAG_TYPE_TASK

tag_valuesarray of stringPublic Preview

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": "DRAFT",
    "share": {},
    "provider_region": {},
    "setting": {},
    "created_at": 0,
    "created_by": "string",
    "updated_at": 0,
    "updated_by": "string",
    "published_at": 0,
    "published_by": "string",
    "categories": [
      "ADVERTISING_AND_MARKETING"
    ],
    "listingType": "STANDARD",
    "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": "FREE",
    "pricing_model": "string",
    "update_frequency": {},
    "collection_granularity": {},
    "collection_date_start": 0,
    "collection_date_end": 0,
    "data_source": "string",
    "size": 0,
    "assets": [
      "ASSET_TYPE_GIT_REPO"
    ],
    "license": "string",
    "tags": [
      {}
    ]
  }
}

Get a listing Public Preview

GET /api/2.0/marketplace-provider/listings/{id}

Get a listing

API scopes: marketplace

Parameters

idstringRequiredpath

Response

listingobject

Show child attributesHide child attributes

idstring

summaryobjectRequired

Show child attributesHide child attributes

namestringRequired

subtitlestring

statusstring

Enums

Values:

• DRAFT
• PENDING
• PUBLISHED
• SUSPENDED

shareobject

Show child attributesHide child attributes

namestringRequired

typestringRequired

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:

Show 22 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

listingTypestringRequired

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_urlstringRequired

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

intervalint64Required

unitstringRequired

Values:

• NONE
• SECOND
• MINUTE
• HOURLY
• DAILY
• WEEKLY
• MONTHLY
• QUARTERLY
• YEARLY

collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes

intervalint64Required

unitstringRequired

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

List listings Public Preview

GET /api/2.0/marketplace-provider/listings

List listings owned by this provider

API scopes: marketplace

Parameters

page_tokenstringquery

page_sizeint32query

Response

Returns a list of Listing objects.

View as Markdown

Response

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

Create a listing Public Preview

POST /api/2.0/marketplace-provider/listing

Create a new listing

API scopes: marketplace

Request body

listingobjectRequired

Show child attributesHide child attributes

idstring

summaryobjectRequired

Show child attributesHide child attributes

namestringRequired

subtitlestring

statusstring

Enums

Values:

• DRAFT
• PENDING
• PUBLISHED
• SUSPENDED

shareobject

Show child attributesHide child attributes

namestringRequired

typestringRequired

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:

Show 22 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

listingTypestringRequired

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_urlstringRequired

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

intervalint64Required

unitstringRequired

Values:

• NONE
• SECOND
• MINUTE
• HOURLY
• DAILY
• WEEKLY
• MONTHLY
• QUARTERLY
• YEARLY

collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes

intervalint64Required

unitstringRequired

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)

Response

listing_idstring

View as Markdown

Request

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

Response

{
  "listing_id": "string"
}

Update listing Public Preview

PUT /api/2.0/marketplace-provider/listings/{id}

Update a listing

API scopes: marketplace

Parameters

idstringRequiredpath

Request body

listingobjectRequired

Show child attributesHide child attributes

idstring

summaryobjectRequired

Show child attributesHide child attributes

namestringRequired

subtitlestring

statusstring

Enums

Values:

• DRAFT
• PENDING
• PUBLISHED
• SUSPENDED

shareobject

Show child attributesHide child attributes

namestringRequired

typestringRequired

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:

Show 22 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

listingTypestringRequired

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_urlstringRequired

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

intervalint64Required

unitstringRequired

Values:

• NONE
• SECOND
• MINUTE
• HOURLY
• DAILY
• WEEKLY
• MONTHLY
• QUARTERLY
• YEARLY

collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes

intervalint64Required

unitstringRequired

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)

Response

listingobject

Show child attributesHide child attributes

idstring

summaryobjectRequired

Show child attributesHide child attributes

namestringRequired

subtitlestring

statusstring

Enums

Values:

• DRAFT
• PENDING
• PUBLISHED
• SUSPENDED

shareobject

Show child attributesHide child attributes

namestringRequired

typestringRequired

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:

Show 22 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

listingTypestringRequired

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_urlstringRequired

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

intervalint64Required

unitstringRequired

Values:

• NONE
• SECOND
• MINUTE
• HOURLY
• DAILY
• WEEKLY
• MONTHLY
• QUARTERLY
• YEARLY

collection_granularityobject

Smallest unit of time in the dataset

Show child attributesHide child attributes

intervalint64Required

unitstringRequired

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

Request

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

Response

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

Delete a listing Public Preview

DELETE /api/2.0/marketplace-provider/listings/{id}

Delete a listing

API scopes: marketplace

Parameters

idstringRequiredpath

View as Markdown

Response

{}

Get provider Public Preview

GET /api/2.0/marketplace-provider/providers/{id}

Get provider profile

API scopes: marketplace

Parameters

idstringRequiredpath

Response

providerobject

Show child attributesHide child attributes

idstring

namestringRequired

descriptionstring

icon_file_pathstring

business_contact_emailstringRequired

support_contact_emailstring

is_featuredboolean

is_featured is accessible by consumers only

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstring

icon_file_idstring

term_of_service_linkstringRequired

privacy_policy_linkstringRequired

dark_mode_icon_file_idstring

dark_mode_icon_file_pathstring

View as Markdown

Response

{
  "provider": {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon_file_path": "string",
    "business_contact_email": "string",
    "support_contact_email": "string",
    "is_featured": true,
    "published_by": "string",
    "company_website_link": "string",
    "icon_file_id": "string",
    "term_of_service_link": "string",
    "privacy_policy_link": "string",
    "dark_mode_icon_file_id": "string",
    "dark_mode_icon_file_path": "string"
  }
}

List providers Public Preview

GET /api/2.0/marketplace-provider/providers

List provider profiles for account.

API scopes: marketplace

Parameters

page_tokenstringquery

page_sizeint32query

Response

providersarray of object

Show child attributesHide child attributes

idstring

namestringRequired

descriptionstring

icon_file_pathstring

business_contact_emailstringRequired

support_contact_emailstring

is_featuredboolean

is_featured is accessible by consumers only

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstring

icon_file_idstring

term_of_service_linkstringRequired

privacy_policy_linkstringRequired

dark_mode_icon_file_idstring

dark_mode_icon_file_pathstring

next_page_tokenstring

View as Markdown

Response

{
  "providers": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "icon_file_path": "string",
      "business_contact_email": "string",
      "support_contact_email": "string",
      "is_featured": true,
      "published_by": "string",
      "company_website_link": "string",
      "icon_file_id": "string",
      "term_of_service_link": "string",
      "privacy_policy_link": "string",
      "dark_mode_icon_file_id": "string",
      "dark_mode_icon_file_path": "string"
    }
  ],
  "next_page_token": "string"
}

Create a provider Public Preview

POST /api/2.0/marketplace-provider/provider

Create a provider

API scopes: marketplace

Request body

providerobjectRequired

Show child attributesHide child attributes

idstring

namestringRequired

descriptionstring

icon_file_pathstring

business_contact_emailstringRequired

support_contact_emailstring

is_featuredboolean

is_featured is accessible by consumers only

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstring

icon_file_idstring

term_of_service_linkstringRequired

privacy_policy_linkstringRequired

dark_mode_icon_file_idstring

dark_mode_icon_file_pathstring

Response

idstring

View as Markdown

Request

{
  "provider": {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon_file_path": "string",
    "business_contact_email": "string",
    "support_contact_email": "string",
    "is_featured": true,
    "published_by": "string",
    "company_website_link": "string",
    "icon_file_id": "string",
    "term_of_service_link": "string",
    "privacy_policy_link": "string",
    "dark_mode_icon_file_id": "string",
    "dark_mode_icon_file_path": "string"
  }
}

Response

{
  "id": "string"
}

Update provider Public Preview

PUT /api/2.0/marketplace-provider/providers/{id}

Update provider profile

API scopes: marketplace

Parameters

idstringRequiredpath

Request body

providerobjectRequired

Show child attributesHide child attributes

idstring

namestringRequired

descriptionstring

icon_file_pathstring

business_contact_emailstringRequired

support_contact_emailstring

is_featuredboolean

is_featured is accessible by consumers only

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstring

icon_file_idstring

term_of_service_linkstringRequired

privacy_policy_linkstringRequired

dark_mode_icon_file_idstring

dark_mode_icon_file_pathstring

Response

providerobject

Show child attributesHide child attributes

idstring

namestringRequired

descriptionstring

icon_file_pathstring

business_contact_emailstringRequired

support_contact_emailstring

is_featuredboolean

is_featured is accessible by consumers only

published_bystring

published_by is only applicable to data aggregators (e.g. Crux)

company_website_linkstring

icon_file_idstring

term_of_service_linkstringRequired

privacy_policy_linkstringRequired

dark_mode_icon_file_idstring

dark_mode_icon_file_pathstring

View as Markdown

Request

{
  "provider": {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon_file_path": "string",
    "business_contact_email": "string",
    "support_contact_email": "string",
    "is_featured": true,
    "published_by": "string",
    "company_website_link": "string",
    "icon_file_id": "string",
    "term_of_service_link": "string",
    "privacy_policy_link": "string",
    "dark_mode_icon_file_id": "string",
    "dark_mode_icon_file_path": "string"
  }
}

Response

{
  "provider": {
    "id": "string",
    "name": "string",
    "description": "string",
    "icon_file_path": "string",
    "business_contact_email": "string",
    "support_contact_email": "string",
    "is_featured": true,
    "published_by": "string",
    "company_website_link": "string",
    "icon_file_id": "string",
    "term_of_service_link": "string",
    "privacy_policy_link": "string",
    "dark_mode_icon_file_id": "string",
    "dark_mode_icon_file_path": "string"
  }
}

Delete provider Public Preview

DELETE /api/2.0/marketplace-provider/providers/{id}

Delete provider

API scopes: marketplace

Parameters

idstringRequiredpath

View as Markdown

Response

{}

All personalization requests across all listings Public Preview

GET /api/2.0/marketplace-provider/personalization-requests

List personalization requests to this provider. This will return all personalization requests, regardless of which listing they are for.

API scopes: marketplace

Parameters

page_tokenstringquery

page_sizeint32query

Response

personalization_requestsarray of object

Show child attributesHide child attributes

idstring

consumer_regionobjectRequired

Show child attributesHide child attributes

cloudstring

regionstring

contact_infoobject

Show child attributesHide child attributes

first_namestring

last_namestring

emailstring

companystring

commentstring

intended_usestring

statusstring

Values:

• NEW
• REQUEST_PENDING
• FULFILLED
• DENIED

status_messagestring

shareobject

Share information is required for data listings but should be empty/ignored for non-data listings (MCP and App).

Show child attributesHide child attributes

namestringRequired

typestringRequired

Values:

• SAMPLE
• FULL

created_atint64

listing_idstring

updated_atint64

metastore_idstring

listing_namestring

is_from_lighthouseboolean

provider_idstring

recipient_typestring

Values:

• DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS
• DELTA_SHARING_RECIPIENT_TYPE_OPEN

next_page_tokenstring

View as Markdown

Response

{
  "personalization_requests": [
    {
      "id": "string",
      "consumer_region": {},
      "contact_info": {},
      "comment": "string",
      "intended_use": "string",
      "status": "NEW",
      "status_message": "string",
      "share": {},
      "created_at": 0,
      "listing_id": "string",
      "updated_at": 0,
      "metastore_id": "string",
      "listing_name": "string",
      "is_from_lighthouse": true,
      "provider_id": "string",
      "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS"
    }
  ],
  "next_page_token": "string"
}

Update personalization request status Public Preview

PUT /api/2.0/marketplace-provider/listings/{listing_id}/personalization-requests/{request_id}/request-status

Update personalization request. This method only permits updating the status of the request.

API scopes: marketplace

Parameters

listing_idstringRequiredpath

request_idstringRequiredpath

Request body

statusstringRequired

Values:

• NEW
• REQUEST_PENDING
• FULFILLED
• DENIED

reasonstring

shareobject

Show child attributesHide child attributes

namestringRequired

typestringRequired

Values:

• SAMPLE
• FULL

Response

requestobject

Show child attributesHide child attributes

idstring

consumer_regionobjectRequired

Show child attributesHide child attributes

cloudstring

regionstring

contact_infoobject

Show child attributesHide child attributes

first_namestring

last_namestring

emailstring

companystring

commentstring

intended_usestring

statusstring

Values:

• NEW
• REQUEST_PENDING
• FULFILLED
• DENIED

status_messagestring

shareobject

Share information is required for data listings but should be empty/ignored for non-data listings (MCP and App).

Show child attributesHide child attributes

namestringRequired

typestringRequired

Values:

• SAMPLE
• FULL

created_atint64

listing_idstring

updated_atint64

metastore_idstring

listing_namestring

is_from_lighthouseboolean

provider_idstring

recipient_typestring

Values:

• DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS
• DELTA_SHARING_RECIPIENT_TYPE_OPEN

View as Markdown

Request

{
  "status": "NEW",
  "reason": "string",
  "share": {
    "name": "string",
    "type": "SAMPLE"
  }
}

Response

{
  "request": {
    "id": "string",
    "consumer_region": {},
    "contact_info": {},
    "comment": "string",
    "intended_use": "string",
    "status": "NEW",
    "status_message": "string",
    "share": {},
    "created_at": 0,
    "listing_id": "string",
    "updated_at": 0,
    "metastore_id": "string",
    "listing_name": "string",
    "is_from_lighthouse": true,
    "provider_id": "string",
    "recipient_type": "DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS"
  }
}

Get a file Public Preview

GET /api/2.0/marketplace-provider/files/{file_id}

Get a file

API scopes: marketplace

Parameters

file_idstringRequiredpath

Response

file_infoobject

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.

View as Markdown

Response

{
  "file_info": {
    "id": "string",
    "marketplace_file_type": "PROVIDER_ICON",
    "file_parent": {},
    "mime_type": "string",
    "download_link": "string",
    "created_at": 0,
    "updated_at": 0,
    "display_name": "string",
    "status": "FILE_STATUS_PUBLISHED",
    "status_message": "string"
  }
}

List files Public Preview

GET /api/2.0/marketplace-provider/files

List files attached to a parent entity.

API scopes: marketplace

Parameters

file_parentobjectRequiredquery

Show child attributesHide child attributes

parent_idstring

file_parent_typestring

Values:

• PROVIDER
• LISTING
• LISTING_RESOURCE

page_tokenstringquery

page_sizeint32query

Response

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.

next_page_tokenstring

View as Markdown

Response

{
  "file_infos": [
    {
      "id": "string",
      "marketplace_file_type": "PROVIDER_ICON",
      "file_parent": {},
      "mime_type": "string",
      "download_link": "string",
      "created_at": 0,
      "updated_at": 0,
      "display_name": "string",
      "status": "FILE_STATUS_PUBLISHED",
      "status_message": "string"
    }
  ],
  "next_page_token": "string"
}

Create a file Public Preview

POST /api/2.0/marketplace-provider/files

Create a file. Currently, only provider icons and attached notebooks are supported.

API scopes: marketplace

Request body

file_parentobjectRequired

Show child attributesHide child attributes

parent_idstring

file_parent_typestring

Values:

• PROVIDER
• LISTING
• LISTING_RESOURCE

marketplace_file_typestringRequired

Values:

• PROVIDER_ICON
• EMBEDDED_NOTEBOOK
• APP

mime_typestringRequired

display_namestring

Response

upload_urlstring

Pre-signed POST URL to blob storage

file_infoobject

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.

View as Markdown

Request

{
  "file_parent": {
    "parent_id": "string",
    "file_parent_type": "PROVIDER"
  },
  "marketplace_file_type": "PROVIDER_ICON",
  "mime_type": "string",
  "display_name": "string"
}

Response

{
  "upload_url": "string",
  "file_info": {
    "id": "string",
    "marketplace_file_type": "PROVIDER_ICON",
    "file_parent": {},
    "mime_type": "string",
    "download_link": "string",
    "created_at": 0,
    "updated_at": 0,
    "display_name": "string",
    "status": "FILE_STATUS_PUBLISHED",
    "status_message": "string"
  }
}

Delete a file Public Preview

DELETE /api/2.0/marketplace-provider/files/{file_id}

Delete a file

API scopes: marketplace

Parameters

file_idstringRequiredpath

View as Markdown

Response

{}

Get provider analytics dashboard Public Preview

GET /api/2.0/marketplace-provider/analytics_dashboard

Get provider analytics dashboard.

API scopes: marketplace

Response

idstringRequired

versionint64

dashboard_idstringRequired

dashboard_id will be used to open Lakeview dashboard.

View as Markdown

Response

{
  "id": "string",
  "version": 0,
  "dashboard_id": "string"
}

Create provider analytics dashboard Public Preview

POST /api/2.0/marketplace-provider/analytics_dashboard

Create provider analytics dashboard. Returns Marketplace specific id. Not to be confused with the Lakeview dashboard id.

API scopes: marketplace

Response

idstringRequired

View as Markdown

Response

{
  "id": "string"
}

Update provider analytics dashboard Public Preview

PUT /api/2.0/marketplace-provider/analytics_dashboard/{id}

Update provider analytics dashboard.

API scopes: marketplace

Parameters

idstringRequiredpath

id is immutable property and can't be updated.

Request body

versionint64

this is the version of the dashboard template we want to update our user to current expectation is that it should be equal to latest version of the dashboard template

Response

idstringRequired

id & version should be the same as the request

versionint64

dashboard_idstringRequired

this is newly created Lakeview dashboard for the user

View as Markdown

Request

{
  "version": 0
}

Response

{
  "id": "string",
  "version": 0,
  "dashboard_id": "string"
}

Get latest version of provider analytics dashboard Public Preview

GET /api/2.0/marketplace-provider/analytics_dashboard/latest

Get latest version of provider analytics dashboard.

API scopes: marketplace

Response

versionint64

version here is latest logical version of the dashboard template

View as Markdown

Response

{
  "version": 0
}