Metrics

Brand Performance by AI Model

Shows composite performance scores broken down by AI model (ChatGPT, Gemini, Claude, etc.), revealing platform-specific brand strength variations. This endpoint calculates the composite score separately for each AI source, enabling identification of which platforms favor which brands. A brand might score 85 on ChatGPT but only 65 on Gemini, indicating inconsistent AI positioning. Critical for platform-specific optimization strategies and understanding where to focus brand building efforts across different LLM ecosystems. **When to use:** User wants to compare brand performance across AI platforms, identify model-specific weaknesses, optimize for specific LLMs, analyze consistency across sources, or find platform preferences. **Common user queries:** - "How does Nike perform on ChatGPT vs Gemini?" - "Compare brand scores across different AI models" - "Which AI favors our brand?" - "Show score variations by LLM" - "Is brand performance consistent across platforms?" - "Get composite scores by source" **Returns:** Array of brands with composite scores for each AI source. Example: [{"brand": "Nike", "source": "chatgpt-4", "composite_score": 85.5}, {"brand": "Nike", "source": "gemini", "composite_score": 72.0}] Required permission: `read:analysis`.

GET

organizations

{organization_id}

workspaces

{workspace_id}

analyses

{analysis_id}

metrics

summary

brand_composite_score_by_source

Brand Performance by AI Model

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

import requests

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

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

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

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>",
    "source": "<string>",
    "brand_awareness_score": "<string>",
    "pros_and_cons_score": "<string>",
    "attributes_score": "<string>",
    "composite_score": "<string>",
    "month": "2023-12-25",
    "week": "2023-12-25"
  }
]

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

required

Filter by one specific brand. Matching ignores case.

collection_date__gte

string<date>

required

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

collection_date__lt

string<date>

required

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

period

enum<string>

Interval of the timeseries.

Available options:

month,

week

Response

200 - application/json

brand

string

required

source

string

required

brand_awareness_score

string

required

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

pros_and_cons_score

string

required

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

attributes_score

string

required

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

composite_score

string

required

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

month

string<date>

week

string<date>

Brand Performance by AI Model

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

import requests

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

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

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

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>",
    "source": "<string>",
    "brand_awareness_score": "<string>",
    "pros_and_cons_score": "<string>",
    "attributes_score": "<string>",
    "composite_score": "<string>",
    "month": "2023-12-25",
    "week": "2023-12-25"
  }
]

Overview

Core API

Search API

Brand Performance by AI Model

Authorizations

Path Parameters

Query Parameters

Response