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 pointing 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 four categories of content: documents, pages, resource bundles, and folders. The response from the initial POST request is a job identifier that 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 file line contains a JSON object representing a single document, page, resource bundle, 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 requiring token authorization. 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
If you don't have access to a Bloomreach Content environment yet, you can use the Public Developer Environment. Follow the instructions to retrieve an authentication token and explore the APIs.
Run in Postman
Import the Content Batch Export API collection and try the endpoints in Postman. The collection provides many examples of how the endpoints can be used.
The only thing needed to use the Postman collection is to set up the environment variables:
brxHost: the URL of your Bloomreach Content environmentx-auth-token: the Authentication token