Dev Studio is a section of the Bloomreach dashboard that is intended for our developers and IT partners. Dev Studio enables you to get more insight into integration touchpoints, including feed, pixel, and API.
The Account Information section contains a list of high-level account configurations including your Account ID, Auth Keys, and FTP User ID/Password. Please note that the Auth Keys in this section differ from the Dataconnect Bearer keys provided to you for feed ingestion and indexing. This Auth Key refers to the auth_key parameter in the Search and Category API request.
The Pixel Monitor section of Dev Studio contains pixel monitors which let you know the health of your Bloomreach pixel integration. There are over 30 different pixel alerts tracking your pixel health across Page Views and Page Events with debugging details on what to do in case a pixel anomaly is found. The Pixel Monitor lets you quickly answer the questions:
- Is my site sending the appropriate number of page views and events?
- Are my page views and events sending their associated required parameters?
The Pixel Monitor is packed with features. To learn more about how to use this tool, please visit this link.
During the Integration, the Pixel Monitor helps you understand if your site is sending the appropriate pixel fires and required information so that you know your development work is complete.
Post integration, the Pixel Monitor can help you track and ensure that your site is behaving as expected.
The Feed section of Dev Studio contains a Feed Status page, which lets you know the current processing status of all of your Bloomreach feeds. It lets you quickly answer questions like:
- What is the status of the feed processing?
- When was the last time my feed was processed?
- How long does it take for Bloomreach to process my feed?
During the integration process, the Feed Status page helps you understand if your feed is running, has the correct entities (number of PIDs, SKUs, URLs), and can save turnaround time if there is a feed failure.
Post integration, the Feed Status page can help you track and ensure that your feed is processed as expected.
Please refer to the relevant section below, based on the type of feed for your account:
- Go to Settings > DevStudio > Feed > Status
- Use the dropdown options as needed to select the feed whose status you want to view.
Domain: For single-site merchants, the only option available is Default. For multi-site merchants, you would see all the domain keys available for your account.
Feed: The options available are "Full" (i.e., daily product catalog) or "Delta" (intra-day product catalog)
Environment: The options available are "Staging" and "Production." These correspond to the feed loaded into your staging/production environment for the Feature APIs (Search, Category, AutoSuggest).
- Go to Settings > DevStudio > Catalogs. Based on your index type, select Product/Content.
- In the resulting screen, select the specific product/content catalog whose feed status you want to check.
- Once you select the catalog, you can view the following details for each Ingest/Update job that has run for your catalog.
a. Job type / status: This can be any one of Ingest Full, Ingest Delta, or Index Update. Ingest Full indicates a PUT request, whereas Ingest Delta and Index Update indicate PATCH and POST requests respectively.
b. Job ID: This indicates the randomly generated job ID that is returned as part of the response to PUT/PATCH/POST request.
c. Details: Provides information about the number of product and variant records stored in the Search index.
d. Start Time (UTC) and End Time (UTC): The start and end times for the job.
e. Duration: Different between the Start and End Times for the job.
Viewing Jobs via Catalog Management
To view Job status, we suggest that you use the Jobs tab on Catalog Management instead.
API Explorer lets you explore Bloomreach APIs interactively and in real time.
It lets you quickly answer the following questions:
- Are Bloomreach APIs returning expected results?
- Are my API calls set up correctly?
During the integration, API Explorer helps you go through examples of what the API request should look like given specific parameter selections and understand if your feed is set up correctly to ensure expected results from Bloomreach APIs.
Post integration, API Explorer can help you ensure that Bloomreach personalization APIs return results as expected.
Exploring APIs via Catalog Management
To explore Bloomreach APIs interactively, we suggest that you use the search tab on Catalog Management instead.
Updated 22 days ago