Example Response Objects

Ping Response Object

AttributeDescriptionValues
pathsArray of prompts for which the end user is eligibleSee here for prompt attributes
path_segmentsOnly utilized by SDK
segmentsArray of Segment objectsSee here for Segment attributes
configsConfig objectSee here for Config attributes
resetIndicate whether client should reset state for current end usertrue, false
anonymous_user_idUnique anonymous identifier for end user. This automatically generated by Redfast unless specified by the client.
visitor_idAuthenticated identifier for end user

Path Object

AttributeDescriptionValues
idUnique identifier for Prompt
nameName of prompt
device_typeDevice type to which prompt appliesweb, ios, tv_os, android_os, roku_os (addl custom device types may be available)
path_typePrompt type1 = invisible, 2 = popup, 5 = horizontal, 6 = video, 7 = text, 8 = vertical, 9 = tile, 10 = interstitial, 11 = notification, 13 = bottom banner
triggersArray of Triggers objectsSee here for Trigger attributes
action_group_idID of variation assigned to end user
actionsPrompt attributesSee here for description of all attributes
display_typeGuidance on how the inline prompt (i.e. horizontal, vertical) should be rendered by the SDKstack (default), slider, list - See here for details
path_group_slugSDK specific identifier for Zone
zoneName of zone utilized by inline prompt
zone_typeZone typecode (default), live (only applies to JS SDK)
orderOrder in which inline prompts should be rendered<integer>
website_actionsCustom code to be executed upon prompt interaction (Only utilized by SDK)
settingsSDK specific rendering settings

Segment Object

AttributeDescriptionValues
idUnique identifier for Segment
nameName of Segment

Trigger Object

AttributeDescriptionValues
idUnique identifier for Trigger
trigger_typePlatform value for triggerweb, device
url_pathURL path or screen namecan be regexp
url_hash (optional)
click_id (optional)ID of click targetFor browsers, can be CSS style selector.
query_params (optional)
delay_secondsNumber of seconds to wait before rendering prompt<number of seconds>
click_count_thresholdNumber of times click_id is invoked betwen triggering prompt<integer>
use_regexSpecify whether url_path should be considered a regexptrue, false
injectOnly utilized by SDK
custom_trigger_argsOnly utilized by SDK
custom_trigger_secondsOnly utilized by SDK

Config Object

AttributeDescriptionValues
idUnique identifier for Trigger
ping_frequencyNumber of seconds client should wait before issuing next Ping request<integer>
last_updateEpoch of time at which response objecdt was last updated<epoch timestamp>
device_typeDevice type to which prompt appliesweb, ios, tv_os, android_os, roku_os (addl custom device types may be available)
autoingestOnly utilized by SDK