curl --request GET \
--url https://api.extole.io/v1/components/{component_id}/selectable-by-references \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v1/components/{component_id}/selectable-by-references"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.extole.io/v1/components/{component_id}/selectable-by-references', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.extole.io/v1/components/{component_id}/selectable-by-references",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.extole.io/v1/components/{component_id}/selectable-by-references"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.extole.io/v1/components/{component_id}/selectable-by-references")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/selectable-by-references")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"campaign_id": "<string>",
"campaign_name": "<string>",
"component_id": "<string>",
"component_name": "<string>",
"selection": "SELECTABLE",
"setting_name": "<string>",
"setting_type": "ADMIN_ICON",
"socket_name": "<string>",
"variant": "<string>"
}
]List the references a component can be selected by
Returns the COMPONENT_REFERENCE and COMPONENT_REFERENCE_LIST settings across the client that can select the specified component — the reverse of GET /v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components. A reference is listed when it already points at the component (SELECTED), or when the component is eligible for it: the component carries the reference’s declared component type, sits inside the reference’s boundary, and is not excluded by one of its selectable filters. Matching runs entirely on the server, so callers never reproduce match rules. One row per component, setting and variant. The result is computed per request and never persisted.
The search covers every non-archived campaign of the client at its latest version, so the row count is driven by how those references declare their boundary: campaign-scoped references match only within their own campaign, while an account-scoped reference can match a component anywhere in the client.
curl --request GET \
--url https://api.extole.io/v1/components/{component_id}/selectable-by-references \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v1/components/{component_id}/selectable-by-references"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.extole.io/v1/components/{component_id}/selectable-by-references', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.extole.io/v1/components/{component_id}/selectable-by-references",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.extole.io/v1/components/{component_id}/selectable-by-references"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.extole.io/v1/components/{component_id}/selectable-by-references")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/selectable-by-references")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"campaign_id": "<string>",
"campaign_name": "<string>",
"component_id": "<string>",
"component_name": "<string>",
"selection": "SELECTABLE",
"setting_name": "<string>",
"setting_type": "ADMIN_ICON",
"socket_name": "<string>",
"variant": "<string>"
}
]Authorizations
Path Parameters
Response
The selectable-by references, each marked SELECTED or SELECTABLE.
The campaign the selectable-by reference belongs to.
The name of that campaign, so a list can be grouped without a second request.
The component that declares the selectable-by reference setting.
The name of that component.
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.
SELECTABLE, SELECTED The name of the selectable-by reference setting, or of the socket parameter that declares it.
Whether the selectable-by reference holds one component or many.
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 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.
The setting value variant this row is about.
Was this page helpful?