Read the omnisearch configuration

GET

/omnisearch/config.json

const url = 'https://work.optidata.cloud/api/omnisearch/config.json';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://work.optidata.cloud/api/omnisearch/config.json \
  --header 'Authorization: Bearer <token>'

Configuration document for the quick-search widget. Treat it as an open object; it is a placeholder today and will grow with the feature.

Authorizations

bearerAuth

Responses

200

Omnisearch configuration.

application/json

object

key

additional properties

any

Examples

config

{
  "message": "Hello World!"
}

401

Missing, malformed or expired authentication key.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

missing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

429

Rate limit exceeded. Retry after the window resets.

application/json

Generic error envelope used by policy, binding and framework failures.

object

message

required

Human-readable description of the failure.

string

Examples

throttled

{
  "message": "Too Many Attempts."
}