Metrics

Cluster Distribution Per Brand

Shows how each brand's perception is distributed across different themes (cluste rs), revealing each brand's unique strength and weakness profile. For each brand, this endpoint calculates what percentage of their mentions falls into each theme. For example, Nike might be 30% 'comfortable', 25% 'sporty', 45% 'style', while Adidas has a different distribution. Essential for understanding and comparing each brand's positioning and what themes define their perception. **When to use:** User wants to compare brand profiles, understand a specific brand's strengths/weaknesses distribution, identify what themes define each brand, or find brands with similar perception patterns. **Common user queries:** - "What are Nike's main strengths?" - "Show me the pros breakdown for each brand" - "Compare cluster distribution across brands" - "Which themes define Adidas?" - "What percentage of Nike's perception is about comfort?" - "Get brand profiles for all competitors" **Returns:** Object with brand names containing their cluster distributions. Example: {"Nike": {"Comfortable": "0.30", "Sporty": "0.25", "Style": "0.45"}, "Adidas": {"Comfortable": "0.20", "Sporty": "0.16", "Style": "0.64"}} Required permission: `read:analysis`.

GET

organizations

{organization_id}

workspaces

{workspace_id}

analyses

{analysis_id}

metrics

brand_perception

cluster_share_by_brand

Cluster Distribution Per Brand

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

import requests

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

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/cluster_share_by_brand', 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/cluster_share_by_brand",
  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/cluster_share_by_brand"

	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/cluster_share_by_brand")
  .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/cluster_share_by_brand")

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

{
  "Nike": {
    "Comfortable": "0.30",
    "Sporty": "0.2500",
    "Style": "0.4500"
  },
  "Adidas": {
    "Comfortable": "0.20",
    "Sporty": "0.1550",
    "Style": "0.6450"
  },
  "Puma": {
    "Comfortable": "0.40",
    "Sporty": "0.4545",
    "Style": "0.1455"
  },
  "Reebok": {
    "Comfortable": "0.1500",
    "Sporty": "0.6000",
    "Style": "0.2500"
  }
}

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

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

Brand name

{key}

object

Attribute name

Show child attributes

Cluster Distribution Per Brand

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

import requests

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

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/cluster_share_by_brand', 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/cluster_share_by_brand",
  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/cluster_share_by_brand"

	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/cluster_share_by_brand")
  .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/cluster_share_by_brand")

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

{
  "Nike": {
    "Comfortable": "0.30",
    "Sporty": "0.2500",
    "Style": "0.4500"
  },
  "Adidas": {
    "Comfortable": "0.20",
    "Sporty": "0.1550",
    "Style": "0.6450"
  },
  "Puma": {
    "Comfortable": "0.40",
    "Sporty": "0.4545",
    "Style": "0.1455"
  },
  "Reebok": {
    "Comfortable": "0.1500",
    "Sporty": "0.6000",
    "Style": "0.2500"
  }
}

Overview

Core API

Search API

Cluster Distribution Per Brand

Authorizations

Path Parameters

Query Parameters

Response