Kameleoon.API.Segments - Kameleoon Documentation

This module provides methods to manage segments and targeting.

getAll

The getAll() method returns all live segments, including those associated with experiments, personalizations, or Audience tracking.

let segments = Kameleoon.API.Segments.getAll();

Return value

Name	Type	Description
segments	Array	List of Segment objects.

getById

The getById() method returns the segment for the specified ID.

let segment = Kameleoon.API.Segments.getById(123456);

Arguments

Name	Type	Description
id	Number	ID of the segment. This field is mandatory.

Return value

Name	Type	Description
segment	Object	Segment object.

getByName

The getByName() method returns the segment for the specified name.

let segment = Kameleoon.API.Segments.getByName("My segment");

Arguments

Name	Type	Description
name	String	Name of the segment. This field is mandatory.

Return value

Name	Type	Description
segment	Object	Segment object.

reevaluate

The reevaluate() method forces an immediate re-evaluation of the targeting conditions for the specified segment. Evaluation typically occurs at page load, resulting in statuses of true, false, or undefined. This method restarts the evaluation process as if the engine just initialized.

Kameleoon.API.Utils.addEventListener(document.body, "mouseleave", function (event) {
  if (event.clientY < 0) {
    Kameleoon.API.Segments.reevaluate(123456);
  }
});

Arguments

Name	Type	Description
id	Number	ID of the segment. This field is mandatory.

trigger

The trigger() method forces a segment trigger for the current visitor and bypasses targeting conditions.

Kameleoon.API.Segments.trigger(12345);

Arguments

Name	Type	Description
id	Number	ID of the segment. This field is mandatory.

APIs

​getAll

​getById

​getByName

​reevaluate

​trigger

getAll

getById

getByName

reevaluate

trigger