Metrics

Hierarchical Perception Tree View

Provides a complete hierarchical tree structure showing clusters → attributes → brands → sources, with mention counts at each level. This endpoint returns a nested data structure perfect for visualization, showing how perception flows from high-level themes (clusters) down through specific attributes, to which brands are associated with each attribute, and which AI sources mentioned them. The tree includes mention counts, making it easy to see volume and importance at each level. Ideal for comprehensive perception analysis and creating sunburst or tree visualizations. **When to use:** User wants a complete hierarchical view of perception data, needs data structured for tree visualizations, wants to explore perception from themes down to specific brand mentions, or requires full detail with counts at every level. **Common user queries:** - "Show me the complete perception hierarchy" - "Get the full cluster breakdown with brands" - "I need hierarchical data for visualization" - "Show clusters, attributes, and brands in a tree" - "Get the nested structure of pros and cons" - "What's the full breakdown from themes to mentions?" **Returns:** Hierarchical tree object with nested children and mention counts. Example: {"name": "pros", "children": [{"name": "Comfortable", "value": 450, "children": [{"name": "soft", "value": 200, "children": [{"name": "Nike", "value": 120}]}]}]} Required permission: `read:analysis`.

GET

organizations

{organization_id}

workspaces

{workspace_id}

analyses

{analysis_id}

metrics

brand_perception

attributes_hierarchy_tree

Hierarchical Perception Tree View

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree', 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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree",
  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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree"

	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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree")

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

{
  "name": "<string>",
  "children": [
    {
      "name": "<string>",
      "value": 123,
      "children": [
        {
          "name": "<string>",
          "value": 123,
          "children": [
            {
              "name": "<string>",
              "value": 123,
              "children": [
                {
                  "name": "<string>",
                  "value": 123
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

analysis_id

string<uuid>

required

A UUID string identifying the analysis.

organization_id

string<uuid>

required

A UUID string identifying the organization.

workspace_id

string<uuid>

required

A UUID string identifying the workspace.

Query Parameters

brand

string

Filter by one specific brand. Matching ignores case.

brand__in

string

Filter by a list of brands, comma separated without brackets and without spaces around the commas (Ford,Tesla Model Y). Matching ignores case.

cluster__in

string

Filter by a list of clusters. Values should be comma separated, without brackets or spaces

cluster_group

enum<string>

required

Filter by one specific cluster group.

Available options:

all_cons,

all_pros

collection_date

string<date>

Filter by a collection date being equal to the specified date. YYYY-MM-DD format

collection_date__gt

string<date>

Filter by a collection date being greater than the specified date. YYYY-MM-DD format

collection_date__gte

string<date>

Filter by a collection date being greater than or equal the specified date. YYYY-MM-DD format

collection_date__lt

string<date>

Filter by a collection date being less than the specified date. YYYY-MM-DD format

collection_date__lte

string<date>

Filter by a collection date being less than or equal the specified date. YYYY-MM-DD format

country

string

Filter by one specific country.

country__in

string

Filter by a list of countries. Values should be comma separated, without brackets or spaces

format

enum<string>

Available options:

csv,

json

persona

string

Filter by one specific persona.

persona__in

string

Filter by a list of personas. Values should be comma separated, without brackets or spaces

persona_ids

string

Filter by a list of persona IDs. Values should be comma separated, without brackets or spaces. The IDs are resolved to the persona labels recorded on the analysis, so this returns the same rows as the equivalent persona__in call. Use it for analyses that carry persona_ids; analyses predating persona records have none, and must be filtered with persona or persona__in. An ID that is not one of the analysis's personas matches no rows.

source

enum<string>

Filter by one specific source.

Available options:

claude-3-5-sonnet,

claude-4-5-sonnet,

claude-4-6-sonnet,

claude-4-sonnet,

deepseek-chat,

deepseek-reasoner,

deepseek-v3.2-maas,

gemini-1.5-pro,

gemini-2.0-flash,

gemini-2.5-flash,

gemini-2.5-flash-grounded,

gemini-2.5-flash-lite,

gemini-3-flash-preview,

gemini-3.5-flash-lite,

google-ai-mode,

gpt-3.5-turbo,

gpt-4-turbo,

gpt-4o,

gpt-4o-mini-search,

gpt-5,

gpt-5.2,

gpt-5.4-mini,

meta-llama-3.1-70B-instruct-turbo,

meta-llama-3.2-70B-instruct-turbo,

meta-llama-3.3-70B-instruct-turbo,

meta-llama-4-maverick,

mistral-7B-instruct,

muse-spark-1.2,

muse-spark-1.3,

perplexity-sonar,

rufus

source__in

enum<string>

Filter by a list of sources. Values should be comma separated, without brackets or spaces

Available options:

claude-3-5-sonnet,

claude-4-5-sonnet,

claude-4-6-sonnet,

claude-4-sonnet,

deepseek-chat,

deepseek-reasoner,

deepseek-v3.2-maas,

gemini-1.5-pro,

gemini-2.0-flash,

gemini-2.5-flash,

gemini-2.5-flash-grounded,

gemini-2.5-flash-lite,

gemini-3-flash-preview,

gemini-3.5-flash-lite,

google-ai-mode,

gpt-3.5-turbo,

gpt-4-turbo,

gpt-4o,

gpt-4o-mini-search,

gpt-5,

gpt-5.2,

gpt-5.4-mini,

meta-llama-3.1-70B-instruct-turbo,

meta-llama-3.2-70B-instruct-turbo,

meta-llama-3.3-70B-instruct-turbo,

meta-llama-4-maverick,

mistral-7B-instruct,

muse-spark-1.2,

muse-spark-1.3,

perplexity-sonar,

rufus

translate_to_en

boolean

If true, translates clusters and attributes to English. Defaults to false.

Response

Base class with necessary methods overridden

name

string

required

children

object[]

required

Show child attributes

Hierarchical Perception Tree View

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree', 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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree",
  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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree"

	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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/metrics/brand_perception/attributes_hierarchy_tree")

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

{
  "name": "<string>",
  "children": [
    {
      "name": "<string>",
      "value": 123,
      "children": [
        {
          "name": "<string>",
          "value": 123,
          "children": [
            {
              "name": "<string>",
              "value": 123,
              "children": [
                {
                  "name": "<string>",
                  "value": 123
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Overview

Core API

Search API

Hierarchical Perception Tree View

Authorizations

Path Parameters

Query Parameters

Response