inSegment

Last update: 2023-09-27
  • Created for:
  • Experienced
    Developer

Checks if an individual belongs to a given audience.

NOTE

You can retrieve up to 100 audiences.

The audience name must be a string constant. It cannot be a field reference nor an expression.

Audiences are defined in the Adobe Experience Platform. The expression editor provides an autocompleted list of audiences.

Audiences can have three statuses:

  • existing: entity continues to be in the audience.
  • realized: entity is entering the audience.
  • exited: entity is exiting the audience.

Only the individuals with the Realized and Existing audience participation statuses will be considered as members of the audience. For more on how to evaluate an audience, refer to the Segmentation Service documentation.

IF inSegment('segmentName') == true means that you have a segmentMembership with the entered/existing status.

ELSE inSegment('segmentName') == false means that you have a segmentMembership of the exited status.

Category

Adobe Experience Platform

Function syntax

inSegment(<parameter>)

Parameters

Parameter Description Type
Segment The audience name <string>

Signature and returned type

inSegment(<string>)

Returns a boolean.

Example

inSegment("men over 50")

Explanation:

The function will return true if the individual within the journey instance is part of the Adobe Experience Platform audience named “men over 50”, false otherwise.

On this page