Skip to main content

Get a targeting rule

GET 
/targeting-rules/:targetingRuleId

Get a targeting rule with the given id

Request​

Path Parameters

    targetingRuleId int64required

    Id of the targeting rule object

    Example: 12345

Responses​

OK

Schema

    id int64

    Unique Id of the targeting rule

    segmentConfiguration string

    Configuration defining how the segment should be applied

    Possible values: [ALL_VISITORS, GRAPHICAL_PAGES, HEAT_SLICE, PAGE, SAVED_TEMPLATE, SITE, URL]

    segmentId int64

    Id of the associated segment (user group) for targeting. If segment is deprecated, no trigger will be available for this rule.

    siteId int64required

    Id of the project this targeting rule belongs to

    targetingConfigurationParam string

    Additional parameters for trigger configuration. For SAVED_TEMPLATE/HEAT_SLICE - contains segment Id. For PAGE - contains full URL. For URL - contains URL fragment.

    triggerConfiguration string

    Configuration defining how the trigger should be applied. ALL_VISITORS configuration is not allowed for this trigger type

    Possible values: [ALL_VISITORS, GRAPHICAL_PAGES, HEAT_SLICE, PAGE, SAVED_TEMPLATE, SITE, URL]

    triggerId int64

    Id of the associated trigger (activation condition)

Loading...