v1

latestOpenAPI 3.0.02026-08-0610682246.0 KB
Decision Engine

Retrieve the Decision Engine

For compatibility with CDN, any web headers (Referrer, User-Agent) will be accepted and passed onto the rule engine.

get/blaize/decision-engine

Query parameters

pathstring required

Uniquely identifies the content Zephr is making a decision about. Request rules can be configured to only execute when the request path matches a provided regular expression.

sessionstring required

Zephr Session ID - same as the blaize_session cookie used by the CDN and authentication endpoints.

foreign_id.xxxstring required

Foreign ID used to identify the user. The foreign system is parsed as the remainder of the parameter key name following 'foreign_id.'

content_idstring required

Passed as metadata.content_id to the Content API template, used to perform requests to a 3rd party API for additional content information used in making a decision.

jwtstring required

A JSON Web Token, may include identity or product holding claims.

btrstring required

A trusted referrer token. If Zephr generates a matching token using path, passed-in Referer header and a configured secret, all entitlements used in this decision will be temporarily granted for this request.

Response

Response status and body are determined by the executed rule. If there is an error executing the rule, a 200 will be returned.