Metrics

Combined Brand Awareness Metrics

Shows both mention frequency and ranking position for each brand in one response, providing a complete picture of brand awareness and prominence. This endpoint combines two key metrics: how often brands are mentioned (recall) and where they rank when mentioned (prominence). A brand with high mention rate but low position might be frequently mentioned but not prioritized, while high mention rate with high position (low number) indicates market leadership. Perfect for comprehensive brand performance analysis. **When to use:** User wants complete brand awareness data in one call, needs both recall and prominence metrics, wants to avoid multiple API calls, or requires full brand performance profile. **Common user queries:** - "Show me complete brand awareness metrics" - "Get mention rates and positions together" - "What's Nike's full awareness profile?" - "Compare brands on both recall and ranking" - "Give me all brand awareness data" - "Show frequency and position combined" **Returns:** Array of brands with both mention_rate, average_position, and group_details showing the breakdown of original brand names within each unified brand. Example: [{"brand": "Nike", "mention_rate": 0.85, "average_position": 1.2, "group_details": [{"name": "Nike Air Max", "mentions_share": 0.6, "nb_mentions": 600, "average_position": 1.0}, {"name": "Jordan", "mentions_share": 0.4, "nb_mentions": 400, "average_position": 3.0}]}, {"brand": "Adidas", "mention_rate": 0.62, "average_position": 2.5, "group_details": []}] Required permission: `read:analysis`.

GET

organizations

{organization_id}

workspaces

{workspace_id}

analyses

{analysis_id}

metrics

brand_awareness

mention_rate_and_average_position

Combined Brand Awareness Metrics

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

import requests

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

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

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

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": "<string>",
    "mention_rate": "<string>",
    "average_position": "<string>",
    "group_details": [
      {
        "name": "<string>",
        "mentions_share": "<string>",
        "nb_mentions": 123,
        "average_position": "<string>"
      }
    ]
  }
]

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.

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

limit

integer

Limit number of results.

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

Response

brand

string

required

mention_rate

string

required

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

average_position

string

required

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

group_details

object[]

required

Show child attributes

Combined Brand Awareness Metrics

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

import requests

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

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

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

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": "<string>",
    "mention_rate": "<string>",
    "average_position": "<string>",
    "group_details": [
      {
        "name": "<string>",
        "mentions_share": "<string>",
        "nb_mentions": 123,
        "average_position": "<string>"
      }
    ]
  }
]

Overview

Core API

Search API

Combined Brand Awareness Metrics

Authorizations

Path Parameters

Query Parameters

Response