Metrics

Brand Ratings on Specific Attributes

Shows how AI models rate each brand on specific attributes like price, quality, comfort, durability, etc., revealing brand strengths and weaknesses. This endpoint returns AI-generated ratings (typically 0-10 scale) for each brand on configured attributes. Nike might score 9/10 on "style" but 4/10 on "price", revealing perception gaps. Perfect for understanding competitive positioning, identifying brand strengths to emphasize, and weaknesses to address in messaging. **When to use:** User wants to compare brands on specific attributes, identify strengths and weaknesses, understand perception on dimensions like price/quality/comfort, create positioning matrices, or find competitive advantages. **Common user queries:** - "How is Nike rated on comfort?" - "Compare brand ratings on price" - "What are each brand's strengths and weaknesses?" - "Show attribute scores for all brands" - "Which brand scores highest on quality?" - "Get ratings breakdown by attribute" **Returns:** Array with brand, attribute, and average rating scores. Example: [{"brand": "Nike", "attribute": "comfort", "average_rating": "8.00"}, {"brand": "Nike", "attribute": "price", "average_rating": "7.50"}] Required permission: `read:analysis`.

GET

organizations

{organization_id}

workspaces

{workspace_id}

analyses

{analysis_id}

metrics

brand_guided_sentiments

average_attribute_rating

Brand Ratings on Specific Attributes

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

import requests

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

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

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

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

[
  [
    {
      "brand": "Salomon",
      "attribute": "comfort",
      "average_rating": "5.33"
    },
    {
      "brand": "Hoka",
      "attribute": "comfort",
      "average_rating": "5.67"
    },
    {
      "brand": "Adidas",
      "attribute": "comfort",
      "average_rating": "7.00"
    },
    {
      "brand": "Hoka",
      "attribute": "price",
      "average_rating": "7.00"
    },
    {
      "brand": "Nike",
      "attribute": "price",
      "average_rating": "7.50"
    },
    {
      "brand": "Adidas",
      "attribute": "price",
      "average_rating": "8.00"
    },
    {
      "brand": "Nike",
      "attribute": "comfort",
      "average_rating": "8.00"
    }
  ]
]

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

attribute

string

Filter by one specific attribute.

attribute__in

string

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

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.

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 attributes to English. Defaults to false.

Response

brand

string

required

attribute

string

required

average_rating

string

required

Pattern: ^-?\d{0,2}(?:\.\d{0,2})?$

Brand Ratings on Specific Attributes

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

import requests

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

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

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

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

[
  [
    {
      "brand": "Salomon",
      "attribute": "comfort",
      "average_rating": "5.33"
    },
    {
      "brand": "Hoka",
      "attribute": "comfort",
      "average_rating": "5.67"
    },
    {
      "brand": "Adidas",
      "attribute": "comfort",
      "average_rating": "7.00"
    },
    {
      "brand": "Hoka",
      "attribute": "price",
      "average_rating": "7.00"
    },
    {
      "brand": "Nike",
      "attribute": "price",
      "average_rating": "7.50"
    },
    {
      "brand": "Adidas",
      "attribute": "price",
      "average_rating": "8.00"
    },
    {
      "brand": "Nike",
      "attribute": "comfort",
      "average_rating": "8.00"
    }
  ]
]

Overview

Core API

Search API

Brand Ratings on Specific Attributes

Authorizations

Path Parameters

Query Parameters

Response