Accounts and sites tools

list_discovery_accounts

Lists the account names you have access to, sorted alphabetically. Call this first when you don't know which accounts are available, or when another tool reports that several accounts exist and asks you to name one.

Each string in the response is an exact value you can pass as the account_name parameter to other search tools.

Request parameters

This tool takes no parameters.

Response parameters

The tool returns a sorted list[str] of account name strings you're authorized to access. For example, ['your-account-1', 'your-account-2', 'your-account-3']. Pass any of these values as the account_name parameter to other search tools.

list_discovery_sites

Lists the sites configured for an account. A site represents one version of a storefront, usually a region, language, or brand within the same account. Each site carries a domain key that identifies its catalog, an optional view ID, and the site groups it belongs to.

Multi-site accounts organize storefronts in a three-level hierarchy. The account sits at the top, site groups gather related sites such as all English-language storefronts, and each site is an individual storefront version. Rules set at a higher level flow down to everything below them. A site-level rule overrides account- and group-level rules for that site alone.

Use this tool to see which sites and site groups exist, and to retrieve the domain keys and view IDs that other search tools need.

Request parameters

NameTypeRequired?Description
site_group_idstr | nullNoFilters results to a single site group. Omit to return all sites for the account.

Response parameters

The tool returns a DiscoverySitesResponse object with the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
datalist[DiscoverySite]The sites configured for the account.
sizeint | nullThe total number of sites returned.
errorstr | nullError message if the request failed.

The DiscoverySite object has the following fields:

FieldTypeDescription
idint | nullThe site ID.
namestr | nullThe site's display name, for example your_domain_com 472.
externalDomainNamestr | nullThe external domain name.
viewIdstr | nullThe view ID for this site. Null when no view is configured.
domainKeystr | nullThe domain key identifying the catalog, for example your_domain_com.
cmsDomainKeystr | nullThe CMS domain key.
userstr | nullThe user who created or modified the site.
createdAtint | nullUnix timestamp in milliseconds of when the site was created.
modifiedAtint | nullUnix timestamp in milliseconds of when the site was last modified.
accountIdint | nullThe account ID the site belongs to.
sitegroupslist[SiteGroupSummary]The site groups this site belongs to.
visiblebool | nullWhether the site is visible in the dashboard.

The SiteGroupSummary object has the following fields:

FieldTypeDescription
idint | nullThe site group ID.
namestr | nullThe site group name.
createdAtint | nullUnix timestamp in milliseconds of when the site group was created.
modifiedAtint | nullUnix timestamp in milliseconds of when it was last modified.
userstr | nullThe user who created or modified the site group.
accountIdint | nullThe account ID.
userCreatedbool | nullWhether a user created the site group, rather than the system.
merchantNamestr | nullThe merchant name.
externalDomainNamestr | nullThe external domain name for the site group.

© Bloomreach, Inc. All rights reserved.