curl --request GET \
--url https://api.extole.io/v1/audiences/built \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v1/audiences/built"
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/audiences/built', 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/audiences/built",
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/audiences/built"
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/audiences/built")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/audiences/built")
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[
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
]
}
]List built audiences
Returns the rendered (built) audience snapshots that the runtime evaluates against - the resolved name, enabled flag, tags, and component references for every audience the client owns. Filter by name (supports a trailing * wildcard), by enabled (ENABLED, DISABLED, or ANY), and by archived status. Use limit and offset to page (defaults: limit=1000, offset=0). Use GET /v1/audiences for the editable definitions.
curl --request GET \
--url https://api.extole.io/v1/audiences/built \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v1/audiences/built"
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/audiences/built', 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/audiences/built",
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/audiences/built"
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/audiences/built")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/audiences/built")
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[
{
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
]
}
]Authorizations
Query Parameters
Restrict results to audiences whose resolved name matches this filter. A trailing * is treated as a wildcard (promo* matches promo_us, promo_eu, etc.).
When true, include archived audiences in the response. Defaults to false.
Restrict results by the audience's enabled flag. ENABLED returns only audiences whose enabled flag resolves to true, DISABLED only those that resolve to false, and ANY (default) returns both.
Filter applied by GET /v1/audiences/built?enabled=.... ENABLED returns only audiences whose enabled flag resolves to true, DISABLED only those that resolve to false, and ANY returns both.
ANY, DISABLED, ENABLED Maximum number of audiences to return. Defaults to 1000.
Number of audiences to skip before returning results. Use with limit to page through long lists. Defaults to 0.
Response
Successful response
Show child attributes
Show child attributes
Resolved enabled flag for the audience. true means the runtime evaluates the audience; false means it is currently inert.
Stable Extole identifier for the audience.
Resolved display name for the audience.
Free-form tags applied to the audience.
Was this page helpful?