evaluate

Evaluate a CQL query in real-time.

This function evaluates a CQL query in real-time and returns the result.

Signature

This function has the following signature:

function evaluate<T extends JsonValue>(query: string, options: EvaluationOptions): Promise<T>;

The result is a Promise that resolves to the result of the evaluation.

Example

Here is a minimal example of how to use this function:

12345
import {evaluate} from '@croct/plug-react/api';


const result = await evaluate('user is returning', {
  appId: '00000000-0000-0000-0000-000000000000',
});

Parameters

The following list describes the supported parameters:

query
string

The CQL query to evaluate, with a maximum length of 500 characters.

options
object

The evaluation options.

appId(optional)
string

The Application ID to use for client-side requests.

This option is required for client-side applications. For server-side applications, use the apiKey option instead. Specifying both will result in an error.

apiKey(optional)
string

The API key to use for server-side requests.

This option is required for server-side applications. For client-side applications, use the appId option instead. Specifying both will result in an error.

clientId(optional)
string

The ID of the client (browser), in the form of a UUID.

This must be a persistent identifier that uniquely identifies the user across sessions.

If omitted, the user will be treated as anonymous, resulting in no session context and reduced effectiveness of personalization features.

clientAgent(optional)
string

The user agent of the client (browser).

If not specified or unknown, device technology information will be limited or unavailable.

clientIp(optional)
string

The IP address of the client (end-user).

Passing 127.0.0.1 makes the API uses IP address of the incoming request, which is useful for local development.

If not specified or unknown, geographic location information will be limited or unavailable.

userToken(optional)
string

A base64-encoded JSON Web Token (JWT) that identifies the user.

If the Require authenticated token option is enabled in the Application settings, a signed JWT is required. In this case, the token must be signed using an API key with authentication permissions, or the request will fail with an authorization error.

timeout(optional)
number

The maximum fetch time in milliseconds.

Once reached, the SDK will abort the request and reject the promise with a timeout error.

baseEndpointUrl(optional)
string

The base URL to use for the API calls.

By default, the SDK uses the production endpoint. This option is helpful for testing purposes and allows you to point the SDK to another environment, such as a mock server.

These are the endpoints that use the base URL:

PathDescription
/client/web/evaluateEndpoint for client-side evaluation.
/external/web/evaluateEndpoint for server-side evaluation.

See Integration tests for more information on how to mock the API calls.

extra(optional)
object

Additional options to pass to the fetch function.

logger(optional)
object

A custom logger to handle log messages.

By default, all logs are suppressed.

debug
(message: string)=>void

A function to log debug messages.

info
(message: string)=>void

A function to log informational messages.

warn
(message: string)=>void

A function to log warning messages.

error
(message: string)=>void

A function to log error messages.

context(optional)
object

Information about the user context, such as the time zone, campaign, and page.

timeZone(optional)
string

The time zone of the user, represented by an IANA time zone ID, like America/New_York.

This information is used for time-based features like localization and scheduling, and usually comes from the browser's preferences or the user's profile.

campaign(optional)
object

Information about the marketing campaign that brought the user to the page.

For more information on how to use this information, see Marketing variables;

name(optional)
string

The name of the campaign, such as summer-sale.

This information usually comes from the utm_campaign URL parameter.

source(optional)
string

The source of the campaign, such as google.

This information usually comes from the utm_source URL parameter.

medium(optional)
string

The medium of the campaign, such as cpc.

This information usually comes from the utm_medium URL parameter.

term(optional)
string

The term of the campaign, such as running shoes.

This information usually comes from the utm_term URL parameter.

content(optional)
string

The content of the campaign, such as banner ad.

This information usually comes from the utm_content URL parameter.

page(optional)
object

Information about the page the user is currently viewing.

For more information on how to use this information, see Navigation variables.

url
string

The URL of the page, such as https://www.example.com/products.

This information usually comes from the window.location.href property.

title(optional)
string

The title of the page, such as Products.

This information usually comes from the document.title property.

referrer(optional)
string

The URL of the page that linked to the current page, such as https://www.google.com.

This information usually comes from the Referer HTTP header or the document.referrer; property.

attributes(optional)
object

The map of attributes to inject in the evaluation context.

The attributes can be referenced in audience conditions using the context variable. For example, suppose you pass the following attributes:

{cities: ["New York", "San Francisco"]}

You can then reference them in queries like:

context's cities include location's city

For more information, see Context variables.

The following restrictions apply to the attributes:

  • Up to 30 entries and 5 levels deep
  • Keys can be either numbers or non-empty strings with a maximum length of 50 characters
  • Values can be null, numbers, booleans, strings (up to 50 characters), or nested maps
  • Nested maps follow the same constraints for keys and values