Metrics

Brand Awareness Score Evolution

Tracks changes in the composite brand awareness score over time, showing overall brand health trends in a single metric timeline. This endpoint shows how the awareness index evolves by time period, providing a simplified view of brand performance trends without juggling multiple metrics. Perfect for executive dashboards, tracking overall brand building progress, or identifying inflection points in brand awareness. One number tells the whole story of brand momentum. **When to use:** User wants simplified trend tracking, needs one metric for dashboards, wants to monitor overall brand health over time, or requires executive-friendly trend visualization. **Common user queries:** - "How has brand awareness evolved over time?" - "Show me awareness score trends" - "Track overall brand health" - "Is awareness improving week over week?" - "Display simplified brand performance trends" - "Get awareness index by month" **Returns:** Array of brands with awareness index scores by time period. Example: [{"brand": "Nike", "period": "2024-01-01", "awareness_index": 0.75}, {"brand": "Nike", "period": "2024-01-08", "awareness_index": 0.78}] Required permission: `read:analysis`.

GET

organizations

{organization_id}

workspaces

{workspace_id}

analyses

{analysis_id}

metrics

brand_awareness

awareness_index_timeseries

Brand Awareness Score Evolution

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

import requests

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

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

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

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>",
    "awareness_index": "<string>",
    "collection_date": "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

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.

period

enum<string>

required

Interval of the timeseries.

Available options:

day,

month,

week

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

awareness_index

string

required

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

collection_date

string<date>

required

Brand Awareness Score Evolution

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

import requests

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

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

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

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>",
    "awareness_index": "<string>",
    "collection_date": "2023-12-25"
  }
]

Overview

Core API

Search API

Brand Awareness Score Evolution

Authorizations

Path Parameters

Query Parameters

Response