Entities

These shared structures appear across API v1 responses. Endpoint pages remain the source of truth for fields returned by a specific route.

Pagination

Most list endpoints return a pagination object. The brands endpoint returns total without pagination.

{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 10,
    "limit": 10,
    "offset": 0
  },
  "data": [ ... ]
}

object

Show Pagination object

number

Total number of items matching the query (across all pages)

number

Number of items returned in this response

number

Maximum items per page (as requested or default)

number

Number of items skipped (for pagination)

Synthetic pagination example

To fetch page 2 with 20 items per page:

GET /api/v1/brands/{brandId}/prompts?limit=20&offset=20

Synthetic response:

{
  "success": true,
  "pagination": {
    "total": 156,
    "count": 20,
    "limit": 20,
    "offset": 20
  },
  "prompts": [ ... ]
}

Brand

A brand represents the company or product monitored by a workspace.

Related Endpoints

List Brands, Get Brand Details

Synthetic example:

{
  "id": "brand_01",
  "name": "Acme Analytics",
  "domain": "acme.example",
  "description": "Analytics software for operations teams.",
  "createdAt": "2026-07-15T10:30:00.000Z",
  "stats": {
    "promptsCount": 156,
    "answersCount": 312,
    "competitorsCount": 8
  }
}

string

Opaque brand identifier

string

Brand display name

string

Primary domain associated with the brand

string

Optional brand description (can be null)

string

ISO 8601 timestamp of brand creation

object

Show Brand statistics

number

Total prompts tracked for this brand

number

Total stored answers for this brand

number

Number of competitors (SELF + DIRECT)

Pitch Audit

A Pitch Audit is a read-only report resource generated for an agency prospect. Once completed, its evidence is a snapshot. Competitor and co-competitor reports are subject views derived from the same audit, not separate audit records.

Related Endpoints

List Pitch Audits, Get Pitch Audit, Get Pitch Audit Subject Report

Synthetic example:

{
  "id": "8a218180-6dd7-43c7-a481-f6a1cc72dfd8",
  "status": "COMPLETED",
  "reportSubject": {
    "id": "self",
    "name": "Prospect Brand",
    "isOriginalBrand": true
  },
  "availableSubjects": [
    { "id": "self", "name": "Prospect Brand", "isOriginalBrand": true },
    { "id": "rival.example", "name": "Rival Labs", "isOriginalBrand": false }
  ],
  "answersIncluded": false,
  "answerCount": 24,
  "coCompetitors": [
    {
      "subjectId": "rival.example",
      "name": "Rival Labs",
      "scores": { "geoScore": 64, "mentionRate": 50 },
      "reportUrl": "/api/v1/pitch-audits/8a218180-6dd7-43c7-a481-f6a1cc72dfd8/reports/rival.example"
    }
  ]
}

object

Subject represented by the current report. The original prospect uses self; derived reports use a stable competitor subjectId.

array

All subjects that can be resolved within this audit.

array

Brands that appear in the same answers as the current subject. Use each row’s subjectId or canonical reportUrl to open its derived report. When includeCoCompetitorScores=true, each row also includes its full scores summary.

boolean

Whether the response contains full AI answer text. Answers are excluded by default.

number

Number of answers available, whether or not answer text was requested.

Competitor

A competitor is a brand or domain detected in stored answers and classified relative to the monitored brand.

Related Endpoints

List Competitors, Get Competitor Details, Competitor Evolution

Synthetic example:

{
  "id": "cmp_abc123",
  "name": "Rival Labs",
  "domain": "rival.example",
  "relationship": "DIRECT",
  "totalMentions": 111,
  "shareOfVoice": 8.73,
  "avgPosition": 2.3,
  "avgSentiment": 75.2
}

string

Unique competitor identifier

string

Competitor display name

string

Competitor’s primary domain

string

Relationship type:

SELF: Your own brand
DIRECT: Direct competitor (used in Share of Voice calculation)
INDIRECT: Indirect competitor (mentioned by AI but not a direct rival)

The list endpoint returns SELF and DIRECT by default and can include INDIRECT through the relationship filter. Detail and evolution Share of Voice use SELF and DIRECT mentions. On the list endpoint, Share of Voice uses the relationships selected by the filter.

number

Total number of times mentioned in AI responses

Share of Voice (0-100). This entity’s share of all brand mentions in AI responses: its mentions divided by the total of all SELF and DIRECT mentions. INDIRECT mentions are excluded.

number

Average position when mentioned in lists (1 = first, lower is better)

number

Average mention sentiment on a 0 to 100 scale, or null

Source

A source is a domain cited by AI platforms when generating responses. Track which websites influence AI answers in your industry.

Related Endpoints

Source Domains, Source URLs, Source Evolution

Synthetic example:

{
  "id": "src_xyz789",
  "domain": "publisher.example",
  "type": "MEDIA",
  "isSelf": false,
  "totalMentions": 102,
  "rate": 5.10,
  "avgPosition": 3.2,
  "aiSourceAuthorityScore": 61
}

string

Unique source identifier

string

Source domain name

string

Source category:

INSTITUTIONAL: Government bodies, NGOs, associations, and professional bodies
COMMERCIAL: Companies, online stores, SaaS products, agencies, and corporate sites
MEDIA: Newsrooms, newspapers, magazines, broadcasters, and journalism-led publishers
BLOG: Article-led blogs that are neither newsrooms nor references
SOCIAL: Profile, feed, and creator platforms
FORUM: Discussion, Q&A, and community platforms
EDUCATIONAL: Schools, universities, course platforms, and teaching resources
REFERENCE: Documentation, wikis, encyclopedias, dictionaries, standards, archives, and knowledge bases
OTHER: A known purpose that fits none of the types above

boolean

Whether this source belongs to your brand

number

Total citations in AI responses

number

Share of Citations - percentage of all AI citations from this source (0-100). Example: rate: 5.10 means 5.10% of all citations reference this domain.

number

Average position in source lists (1 = first)

number | null

Latest public AI Source Authority score, or null when no sufficient snapshot is available

Prompt

A prompt is a question monitored across AI providers. Each prompt can have a funnel stage, topic, and tags.

Related Endpoints

List Prompts, Get Prompt Details, Prompt Answers

Synthetic example:

{
  "id": "q_abc123",
  "text": "Which analytics platforms support warehouse exports?",
  "topic": "Data exports",
  "type": "TOFU",
  "tags": ["reviews", "comparison"],
  "personas": [{ "id": "persona_01", "name": "Data lead", "description": null }],
  "modelIds": ["openai-gpt-6.1-sol"],
  "monitoringEnabled": true,
  "frequency": "WEEKLY",
  "frequencyInherited": true,
  "boostCount": 1,
  "answersCount": 2,
  "mentionRate": 50.0,
  "sourceRate": 25.0,
  "lastGeneratedAt": "2026-07-19T10:00:00.000Z"
}

string

Unique prompt identifier

string

The prompt/question text

string

Associated topic/keyword name (can be null)

string

Marketing funnel stage:

TOFU: Top of Funnel (awareness)
MOFU: Middle of Funnel (consideration)
BOFU: Bottom of Funnel (decision)
POST_PURCHASE: Post-purchase (retention and support)

array

List of tag names for organization

array

Personas currently assigned to the prompt, each with id, name, and description

array

Model IDs currently configured on the prompt

boolean

Whether scheduled monitoring is enabled

string

Effective monitoring frequency: NONE, DAILY, WEEKLY, or MONTHLY (can be null)

boolean

Whether the frequency comes from the brand default

number

Responses requested per model and run

number

Number of AI responses generated for this prompt

number

Answers with a SELF mention divided by answers with a SELF or DIRECT mention, from 0 to 100

number

Answers with a SELF citation divided by answers with a SELF or DIRECT citation, from 0 to 100

string

ISO 8601 timestamp of last answer generation

Answer

An answer is stored output from one provider run for a prompt. It contains text, detected mentions, and citations.

Related Endpoints

List Answers, Get Answer Details

Synthetic example:

{
  "id": "ans_123abc",
  "promptId": "q_abc123",
  "promptText": "Which analytics platforms support warehouse exports?",
  "provider": "Example provider",
  "model": "example-model",
  "persona": null,
  "text": "Acme Analytics and Rival Labs both document warehouse exports...",
  "hasSelfMention": true,
  "selfMentionPosition": 3,
  "hasSelfSource": false,
  "competitorsCount": 5,
  "sourcesCount": 3,
  "sentiment": 82,
  "status": "COMPLETED",
  "createdAt": "2026-07-19T10:00:00.000Z"
}

string

Unique answer identifier

string

ID of the associated prompt

string

Text of the associated prompt

string

Provider display name

string

Model display name

object

Persona recorded when the answer was generated, with id, name, and description (can be null)

string

Full response text (or preview in list endpoints)

boolean

Whether your brand is mentioned

number

Position in competitor list when mentioned (null if not mentioned)

boolean

Whether your domain is cited as a source

number

Number of competitors mentioned in this answer

number

Number of sources cited in this answer

number

Sentiment score for the SELF mention on a 0 to 100 scale, or null

string

Processing status: PROCESSING, COMPLETED, or PARTIAL_ERROR. PROCESSING means the response text is available but its analyses are still incomplete

string

ISO 8601 timestamp of answer generation

Competitor mention

Detailed information about a competitor mention within an answer (returned in answer details). Synthetic example:

{
  "name": "Acme Analytics",
  "position": 3,
  "relationship": "SELF",
  "sentiment": 85
}

string

Competitor name as mentioned

number

Position in the response (1 = mentioned first)

string

SELF, DIRECT, or INDIRECT. Answer details return mentions for all relationship types. If you’re computing Share of Voice, filter to only SELF and DIRECT mentions.

number

Sentiment score for this mention on a 0 to 100 scale, or null

Source citation

Detailed information about a source citation within an answer (returned in answer details). Synthetic example:

{
  "url": "https://publisher.example/article",
  "domain": "publisher.example",
  "position": 1,
  "isSelf": false
}

string

Full URL cited (can be null)

string

Domain name of the source

number

Position in source list (1 = cited first)

boolean

Whether this is your own domain

Topic

A topic (also called keyword) groups related prompts together. Synthetic example:

{
  "id": "topic_abc123",
  "name": "Product Reviews"
}

string

Unique topic identifier

string

Topic display name

Tag

Tags allow custom categorization of prompts. Synthetic example:

{
  "id": "tag_xyz789",
  "name": "comparison"
}

string

Unique tag identifier

string

Tag display name

Evolution data point

Used in evolution endpoints to track metrics over time. Synthetic example:

{
  "date": "2026-07-01",
  "mentions": 5,
  "shareOfVoice": 7.2,
  "avgPosition": 2.3,
  "avgSentiment": 76.5
}

string

Date in YYYY-MM-DD format

number

Number of mentions on this date

Share of voice percentage on this date

number

Average position on this date

number

Average SELF mention sentiment on this date, or null

Get started

Configure data

Monitor and measure

Analyze and act

Agency and automation

Implementation guides

Brand

Related Endpoints

Pitch Audit

Related Endpoints

Competitor

Related Endpoints

Source

Related Endpoints

Prompt

Related Endpoints

Answer

Related Endpoints

Competitor mention

Source citation

Topic

Tag

Evolution data point