curl --request GET \
--url https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields \
--header 'authorization: <api-key>'import requests
url = "https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields"
headers = {"authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<api-key>'}};
fetch('https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields', 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.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields",
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.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields"
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.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields")
.header("authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields")
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{
"status": "success",
"data": {
"fields": [
{
"fieldKey": "<string>",
"kind": "column",
"customFilter": null,
"hidden": false,
"coveredBy": [],
"column": "<string>",
"columnDisplayName": "<string>",
"columnType": "string",
"suggestedFilterType": "Input",
"tables": [
{
"table": "<string>",
"column": "<string>",
"tableDisplayName": "<string>"
}
],
"tableChoices": [],
"displayedOnItemIds": [
"<string>"
],
"targets": [
{
"itemId": "<string>",
"itemName": "<string>",
"appliesAs": "raw"
}
],
"unreachableItemIds": [
"<string>"
]
}
],
"tableColumns": null,
"dataModelVersion": 0
}
}{
"status": "error",
"error": {
"message": "<string>",
"code": "<string>",
"details": {}
}
}List Canvas Filterable Fields
List the fields a canvas filter can target — custom filters first, then columns by name — with the tiles each reaches and whether viewers are offered it. With includeTableColumns, also every column of the tables behind the charts, to build a custom filter from
curl --request GET \
--url https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields \
--header 'authorization: <api-key>'import requests
url = "https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields"
headers = {"authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {authorization: '<api-key>'}};
fetch('https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields', 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.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields",
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.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields"
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.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields")
.header("authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/filterable-fields")
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{
"status": "success",
"data": {
"fields": [
{
"fieldKey": "<string>",
"kind": "column",
"customFilter": null,
"hidden": false,
"coveredBy": [],
"column": "<string>",
"columnDisplayName": "<string>",
"columnType": "string",
"suggestedFilterType": "Input",
"tables": [
{
"table": "<string>",
"column": "<string>",
"tableDisplayName": "<string>"
}
],
"tableChoices": [],
"displayedOnItemIds": [
"<string>"
],
"targets": [
{
"itemId": "<string>",
"itemName": "<string>",
"appliesAs": "raw"
}
],
"unreachableItemIds": [
"<string>"
]
}
],
"tableColumns": null,
"dataModelVersion": 0
}
}{
"status": "error",
"error": {
"message": "<string>",
"code": "<string>",
"details": {}
}
}Authorizations
Path Parameters
The project in the URL. The caller's project user is read from it.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$GET /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filterable-fields Parameter
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$GET /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/filterable-fields Parameter
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$Query Parameters
Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.
1The ID of the organization. Required when using Supabase JWT authentication.
The ID of the connection a guest has access to
Published data model version to resolve fields and run queries against. Defaults to the published version.
x <= 9007199254740991Also list tableColumns: every column of the tables behind the charts, one per table, with the tiles a filter on exactly that table's column reaches. Ask for it to build a custom filter.
Was this page helpful?