Content Batch Export API

🚧

Beta feature in version 20220824

This feature will be available as a beta-quality release in version 20220824. There may be known issues with this feature in this version, so please use with caution. The full 1.0 release is expected in a following version.

Introduction

The Content Batch Export API enables developers to export large amounts of content from a Bloomreach Content project.

How it works

A batch export is requested for a specific path, that must point to a folder. Optionally a project id and list of content categories can be provided to control the content that should be exported. There are 4 categories of content: documents, pages, resource bundles, and folders. The response from the initial POST request is a job identifier which the caller can use to poll for the status of the export operation.

When the operation is complete, the caller can obtain a report of the operation results containing all successful and failed items in the batch. The caller can also access the exported content via a separate file download URL.

The file format is a zip containing a JSON lines file, also known as an NDJSON or new line delimited JSON file. Each line of the file contains a JSON object representing a single document, page, resourcebundle, or folder, in the same format used by the Content Import API. These objects make references to the content types and page layouts previously defined in the target channel using the Content Type Management API and Site Management API, which define the expected structure for the data.

API Base URL

https://<your_brx_host>.bloomreach.io/management/content-export/v1

Authorization

The Content Export API is a protected management API and requires authorization using a token. See API Authorization for instructions on how to obtain and use a token.

API Reference

Developer tools

To aid developers in working and learning the Content Batch Export API, the following tools and resources are provided:

Public Environment

In case you don't yet have access to a Bloomreach Content environment, you can Log in to the Public Developer Environment. Follow the instructions to retrieve an authentication token and explore the APIs.

Run in Postman

Easily fork the Content Batch Export API collection and try the endpoints in Postman. The advantage is that in Postman we offer many examples of how the endpoints can be used.

Run in PostmanRun in Postman

The only thing needed to use the Postman collection is to setup the environment variables:

  • brxHost: the URL of your Bloomreach Content environment
  • x-auth-token: the Authentication token

Swagger UI

It's possible to trigger API requests requests directly to a Bloomreach Content environment using the Swagger UI. Via the below URL, explore and try out the Content Batch Export API:

https://<your_brx_host>.bloomreach.io/management/content-export/v1/api-docs