Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt

Use this file to discover all available pages before exploring further.

An analysis is the central data unit of Share Of Model. Everything you read in dashboards or fetch through the API is produced by an analysis: a scoped, configured run that gathers signals from LLMs and search engines and turns them into metrics, perception clusters, and source lists. Analyses come in two flavours, depending on the module:
  • Brand analyses — answer “what does the model think about my brand?” and produce awareness, perception, and source signals.
  • Search projects — answer “where does my brand or domain appear when users search?” and produce visibility, ranking, and citation signals.
The two share the same underlying lifecycle and ownership model.

Scope

When you create an analysis, you define what is being studied. The exact fields differ by module, but the shape is the same:
FieldRequiredNotes
BrandYesThe brand under analysis.
CategoryYesThe market in which the brand competes.
CompetitorsYesExactly 3 competitors, used as the comparative landscape.
AttributesYesExactly 6 attributes used for perception scoring.
LLM modelsYesModels to query (OpenAI, Google AI, Meta AI and Anthropic by default).
RegionsOptionalUp to 8 regions per analysis. Country-prefixed prompts are added per region.
PersonasOptionalUp to 5 personas per analysis. Each persona narrows the prompt audience.
Scope drives credit usage. For brand analyses, credits scale as regions × personas; for search, each tracked query costs a known number of credits per run. See the Credit System for the full breakdown.

Collects

A collect is the result of one execution of an analysis. Each time the platform runs an analysis, it produces a new collect that holds the metrics for that run.
  • Multiple collects can be aggregated to read average performance across a window.
  • Collects can also be compared to a previous set, to read evolution over time.
  • A collect carries a status — only FINISHED collects are usable for reading metrics.
Through the API, collects are how you ask for data:
  • single collect — pass one ID in collect_ids.
  • aggregated metrics — pass several IDs in collect_ids.
  • evolution — also pass IDs in prev_collect_ids to compare against an earlier window.

Lifecycle

An analysis goes through three states from creation to insight:
StatusWhat it means
LaunchingThe analysis has just been created and is being prepared (typically the first 15–20 minutes). Data is not yet available.
CollectingData is being gathered. Trends may shift as more data arrives. Read early signals with care.
LiveData has stabilised and is ready for insights.
Wait at least 2–3 weeks of collection before drawing strategic conclusions from a brand analysis. Perception clusters and attribute scores only stabilise once enough data has been gathered.

Archiving and reactivation

Analyses can be archived for later reference and reactivated when needed.
  • Archived analyses don’t consume credits.
  • Reactivating an analysis re-consumes credits based on its original scope.
  • The period during which an analysis was archived contains no data — data is not backfilled.

Reading the data

Every analysis exposes its data both in the platform UI and via the Core API. The same analysis, read through both surfaces, returns the same metrics.

What’s next

Brand Catalog

How brands and competitors are modelled.

Visibility, Perception & Influence

The three pillars analyses produce.

Brand Analysis Starter Kit

Run your first analysis.

Search Visibility Overview

Run your first search project.