Skip to main content
GET
List the components that use or could use a component

Authorizations

Authorization
string
header
required

Path Parameters

component_id
string
required

Query Parameters

selection
enum<string>

Lists only the references with this selection: SELECTED for the references that already point at the component, SELECTABLE for the references the component could be selected by. Lists both when omitted.

Available options:
SELECTABLE,
SELECTED
having_any_ancestor_types
string

A comma-separated list of component types. Lists only the references held by a component whose parent, grandparent or any further ancestor in its campaign has at least one of these types. The types of the component that holds the reference are not checked. A type also matches its subtypes.

Response

The selectable-by references, each marked SELECTED or SELECTABLE.

campaign_id
string
required

The campaign the selectable-by reference belongs to.

campaign_name
string
required

The name of that campaign, so a list can be grouped without a second request.

component_description
string
required

The description of the component that declares the reference, absent when it has none.

component_display_name
string
required

The display name of the component that declares the reference, from its built campaign. Absent when the component has no display name.

component_id
string
required

The component that declares the selectable-by reference setting.

component_name
string
required

The name of that component.

component_types
string[]
required

The component types of the component that declares the reference.

parent_component_display_name
string
required

The display name of that component's parent, from its built campaign. Absent when the parent has no display name, when the parent is the campaign root, or when the component has no parent.

parent_component_name
string
required

The name of that component's parent. Absent when the parent is the campaign root or the component has no parent.

selection
enum<string>
required

SELECTED when the reference already points at the component in this variant, SELECTABLE when it does not but would accept it. A SELECTED row is reported whether or not the reference would still accept the component today, so a reference whose boundary or filters have since moved away from it is still listed.

Available options:
SELECTABLE,
SELECTED
setting_display_name
string
required

The display name of the reference setting, absent when it has none.

setting_name
string
required

The name of the selectable-by reference setting, or of the socket parameter that declares it.

setting_type
enum<string>
required

Whether the selectable-by reference holds one component or many.

Available options:
ADMIN_ICON,
AUDIENCE_ID,
AUDIENCE_ID_LIST,
BOOLEAN,
BROWSER_SIDE_JAVASCRIPT,
CLIENT_DOMAIN_ID_LIST,
CLIENT_KEY,
CLIENT_KEY_FLOW,
COLOR,
COMPONENT_ID,
COMPONENT_REFERENCE,
COMPONENT_REFERENCE_LIST,
COMPONENT_SETTING_LOOKUP,
CSS,
DATE_TIME,
DELAY,
DELAY_LIST,
ENUM,
ENUM_LIST,
EXTOLE_CLIENT_KEY,
FONT,
GLOB_COMPONENT_PATH,
HTML,
IMAGE,
INTEGER,
INTEGER_LIST,
JSON,
MULTI_SOCKET,
PARTNER_ENUM,
PARTNER_ENUM_LIST,
PERSON_KEY_NAME,
REWARD_SUPPLIER_ID,
REWARD_SUPPLIER_ID_LIST,
SFTP_DIRECTORY,
SOCKET,
STRING,
STRING_LIST,
STRING_MAP,
TRIGGER_CONFIGURATION,
URL,
WEBHOOK_ID
socket_name
string
required

The socket whose parameter declares the selectable-by reference, absent when the reference is a setting on the component itself. Two sockets on one component can declare parameters of the same name, so this is part of the reference's identity.

variant
string
required

The setting value variant this row is about.