Get job details

Get all the details about a particular job including its status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sending modifications to a catalog's products or publishing the index for a catalog will return a job identifier.

You can use the Job ID to get the status of that modification and other information about the job. This helps build observability and alerting systems.

Each job will have the following major information:

  • status_code - Pre-defined codes that describe the status of a job (similar to HTTP response codes)
  • details - In-depth information to understand how the job was processed
"details": [
      {
        "type": "catalogs/internal_error",
        "title": "Internal Server Error",
        "detail": "Something went wrong unexpectedly",
        "resolution": "Retry the job at a later time. If the error persists, please contact Bloomreach support.",
        "class": "error"
      }
    ]

Job status codes

Status codeDescription
100The job status is unknown.
101The job is queued by the client.
102The job is queued by the server.
105The job is currently running.
200The job is successful and completed.
210The job is completed successfully, but there are warnings that may indicate issues that need to be investigated for optimal performance and correctness.
310The job was skipped because it was not needed due to other conditions.
350The job was killed by the user.
430Data format error. The request data was not in the correct format.
440The job was prevented due to a failing precondition check(s).
450The job was prevented from processing due to the existence of a postcondition check(s).
500Internal server error.

Parameters reference

Path Params
string
required
length between 1 and 64

Your unique account name.

string
required
length between 1 and 64

"Catalog name" is also called domain key. Use the same value as your domain key in your search API requests.

string
enum
required
length between 1 and 64

The type of environment you want to use for the request (Production/Staging).

Allowed:
string
required
length between 1 and 64

The job ID returned in the response from sending your catalog data (refer to Upload full feed).

Responses

401

Unauthorized

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© Bloomreach, Inc. All rights reserved.