List Filter Values Handler
curl --request GET \
--url https://api.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values', 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.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <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.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<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.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"values": [
"<string>"
],
"total_count": 123,
"cursor": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Filter Values
List filter values
Returns a paginated list of values in a set filter transform.
GET
/
api
/
v1
/
beam
/
{config_id}
/
transforms
/
{transform_uid}
/
filter-values
List Filter Values Handler
curl --request GET \
--url https://api.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values', 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.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <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.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<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.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid}/filter-values")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"values": [
"<string>"
],
"total_count": 123,
"cursor": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Set filters (
redis_set_filter) are deprecated. New pipelines start with a JavaScript transform. Move your filter values to a dataset and check them with beam.contains() in a JavaScript transform instead.Required permission:
read — owners, editors, readers, and members of teams shared via viewer_team.| Parameter | Description |
|---|---|
config_id | Pipeline configuration ID |
transform_uid | UID of the set filter transform |
| Parameter | Default | Description |
|---|---|---|
cursor | null | Integer offset (0 or greater) from a previous response’s cursor |
count | 100 | Values per page, from 1 to 1,000,000 |
curl -X GET "https://api.allium.so/api/v1/beam/${CONFIG_ID}/transforms/${TRANSFORM_UID}/filter-values?count=100" \
-H "X-API-Key: ${ALLIUM_API_KEY}"
{
"values": ["0x3c499c542cef5e3811e1192ce70d8cc03d5c3359", "0xc2132d05d31c914a87c6611c10748aeb04b58e8f"],
"cursor": 42,
"total_count": 1500
}
| Field | Description |
|---|---|
values | Array of values in the current page |
cursor | Cursor for the next page, or null on the last page |
total_count | Total number of values in the filter |
Was this page helpful?