Articles in this section

Available Bloomreach APIs

When you configure an export, import, or other type of flow step using the prebuilt Bloomreach connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Bloomreach API documentation. You can also create a composite endpoint for this application in HTTP mode.

API type: Engagement

Resource

Endpoint

Export

Import

Analysis

Retrieve funnels

X

Retrieve reports

X

Retrieve retentions

X

Retrieve segmentation

X

Catalog

Create catalog

X

Get list of all catalogs

X

Get catalog name

X

Update a catalog name

X

Delete catalog

X

Get catalog items

X

Get a catalog item

X

Update a catalog item

X

Delete catalog item

X

Catalog item (partial update)

X

Delete all catalog items

X

Bulk update catalog item

X

Bulk delete catalog items

X

Bulk partial update catalog item

X

Customer

Retrieve different customer attributes

X

Export a customer

X

Export all customers

X

Export events

X

Email

Transactional email

X

GDPR

Get consent categories

X

Anonymize one customer

X

Anonymize customers bulk

X

Import

Start import

X

Start export

X

Import management

List imports

X

Read imports

X

Create export

X

Delete export

X

Tracking

System time

X

Update customer properties

X

Add event

X

Batch commands

X

API type: Content delivery

Resource

Endpoint

Export

Import

Delivery 2.0 - Assets

Get assets by ID or path

X

Get assets by query

X

Delivery 2.0 - Documents

Get documents by query

X

Get a document by ID

X

Delivery 2.0 - Folders

Get folder by ID or path

X

Delivery 2.0 - Images

Get images by query

X

Get image by ID or path

X

API type: Discovery

Resource

Endpoint

Export

Import

DC content

Job status

X

Publish the index

X

Put: send your data (content)

X

Patch: send your data (content)

X

DC product

Put: send your data (product)

X

Patch: send your data (product)

X

API type: Content management

Resource

Endpoint

Export

Import

Content batch export operations

Get operation details

X

List all operations

X

Request an export

X

Get operation details

X

Create content (documents and pages) in a specific project.

X

List all operations

X

Content integration management: UI extensions config operations

Get a single custom ui extension

X

Create or update a custom ui extension

X

Delete a custom ui extension

X

Get content types that use an existing ui extension

X

Get all custom ui extensions

X

Content management: Content document operations

Get a document in a specific project

X

Create or update a document in a specific project

X

Dissociate a document from a project

X

Content management: Content page operations

Get a page in a specific project

X

Create or update a page in a specific project and channel

X

Dissociate an experience page from a project

X

Content management: Content resource bundle operations

Get a resource bundle in a specific project

X

Create or update a resource bundle in a specific project

X

Dissociate a resource bundle document from a project

X

Content management: Content translation operations

Get translations of the content

X

Link the source and target content as translations of each other

X

Unlink the content from any existing translations

X

Get the status of a link/unlink operation

X

Content type management: Content type operations

Get a content type

X

Create or update a content type

X

Delete a content type

X

Get all content types

X

Rename a content type

X

Folder management operations

Get a folder

X

Create or update a folder

X

Delete a folder

X

Move/rename a folder

X

Get a developer project

X

Update a developer project

X

Delete a developer project

X

Get all developer projects

X

Create a developer project

X

Rebase a developer project

X

Merge a developer project

X

Reopen a developer project

X

Site management: Channel component operations

Get a channel component group

X

Create or update a channel component group

X

Delete an empty channel component group

X

Get a component within a component group

X

Create or update a component within a component group

X

Delete an unreferenced component from a component group

X

Get all components for a component group

X

Get all component groups for a channel

X

Site management: Channel layout operations

Get a channel layout

X

Create or update a channel layout

X

Delete a channel layout

X

Get the channel layouts

X

Site management: Channel menu operations

Get a channel menu (name)

X

Create a channel menu (name)

X

Delete a channel menu

X

Get channel menu items

X

Update channel menu items

X

Get channel menu template properties

X

Create or update channel menu template properties

X

Get all channel menu (names)

X

Site management: Channel operations

Get meta data for a channel parameter

X

Add or update meta data for a channel parameter

X

Delete channel parameter meta data

X

Get meta data for a field group

X

Add or update meta data for a field group

X

Delete a field group

X

Get a channel

X

Update an existing channel

X

Delete an existing channel

X

Get meta data for all channel parameters

X

Get all channels

X

Create a channel developer branch

X

Get meta data for all field groups

X

Site management: Channel route operations

Get a route

X

Create or update a route

X

Delete a route

X

Get the channel routes

X

Webhook management: Webhook configuration operations

Get a webhook configuration

X

Update a webhook configuration

X

Delete a webhook configuration

X

Get all webhook configurations

X

Create a webhook configuration

X

Webhook management: Webhook execution operations

Get a webhook execution

X

Get all webhook executions

X