LLM Pulse Mentions & Citations API
The raw records behind the visibility metrics: one row per brand mention or per cited URL, for the project brand, for competitors, or for both in a single stream.
The raw records behind the visibility metrics: one row per brand mention or per cited URL, for the project brand, for competitors, or for both in a single stream.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/llmpulse-ai:llmpulse-ai-mentions-citations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: LLM Pulse Mentions & Citations API
description: 'REST API for the LLM Pulse AI visibility platform. Track brand mentions, citations, sentiment, and Share of Voice across AI-generated answers (ChatGPT, Perplexity, Gemini, Google AI Overviews, Google AI Mode, and optional add-on models). Includes the MCP (Model Context Protocol) endpoint for AI clients. MCP is available on every plan and during eligible trials via OAuth 2.1, with Bearer-token API keys also accepted for headless integrations on the Scale plan or above. Full machine-readable reference at https://llmpulse.ai/api-docs/llms-full.txt. An API key can be limited to one or several projects when it is created, and the set never changes. Such a key sees only those projects: any other project id, domain or name answers ERR_PROJECT_NOT_FOUND exactly like a project that does not exist, listings return only those projects'' rows, and operations on the whole account (creating or deleting a project, the project draft wizard) answer ERR_KEY_PROJECT_SCOPED. Operations carry vendor extensions: x-plan is the plan or entitlement the endpoint requires beyond an API key (growth, scale or reputation_access), x-write marks endpoints that need a read and write key, x-mcp-tool names the MCP tool that returns the same data, x-mcp-plan gives that tool''s plan where it differs, and x-rest-only explains an endpoint with no MCP tool. Parameters are read strictly, on REST and MCP alike: a value outside a documented enum, a boolean other than true, false, 1 or 0, an id or count that is not a plain positive number (12abc, 1.0 or 0), an id of a record the project does not have, or a from later than to answers 422 ERR_INVALID_PARAM naming the parameter, never an ignored filter. A listed value, in a query or a request body, matches in any letter case and is read in its documented spelling (granularity=Week reads as week, aggregation_type=BYPAGE as byPage, event_type=Mention.Created as mention.created). page and per_page keep their own rule: a value that is not a number reads as absent and an out-of-range one is clamped.'
version: 1.97.0
contact:
name: LLM Pulse Support
url: https://llmpulse.ai
email: info@llmpulse.ai
license:
name: Proprietary
url: https://llmpulse.ai/terms
servers:
- url: https://api.llmpulse.ai/api/v1
description: Production API
security:
- BearerAuth: []
tags:
- name: Mentions & Citations
description: 'The raw records behind the visibility metrics: one row per brand mention or per cited URL, for the project brand, for competitors, or for both in a single stream.'
paths:
/dimensions/mentions:
get:
tags:
- Mentions & Citations
summary: List brand mentions
x-llms-description: Paginated brand mention records (project brand only).
operationId: listMentions
x-mcp-tool: list_mentions
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Model'
- $ref: '#/components/parameters/CollectionId'
- $ref: '#/components/parameters/CountryCode'
- $ref: '#/components/parameters/LanguageCode'
- $ref: '#/components/parameters/Prompt'
- $ref: '#/components/parameters/ListingFrom'
- $ref: '#/components/parameters/ListingTo'
- $ref: '#/components/parameters/Output'
- $ref: '#/components/parameters/PromptType'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/Range'
responses:
'200':
description: Paginated brand mentions
content:
application/json:
schema:
$ref: '#/components/schemas/MentionsResponse'
/dimensions/citations:
get:
tags:
- Mentions & Citations
summary: List brand citations
x-llms-description: Paginated brand citation records (project brand only).
description: Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
operationId: listCitations
x-mcp-tool: list_citations
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Model'
- $ref: '#/components/parameters/CollectionId'
- $ref: '#/components/parameters/CountryCode'
- $ref: '#/components/parameters/LanguageCode'
- $ref: '#/components/parameters/Prompt'
- $ref: '#/components/parameters/ListingFrom'
- $ref: '#/components/parameters/ListingTo'
- $ref: '#/components/parameters/Output'
- $ref: '#/components/parameters/PromptType'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/Range'
responses:
'200':
description: Paginated brand citations
content:
application/json:
schema:
$ref: '#/components/schemas/CitationsResponse'
/dimensions/competitor_mentions:
get:
tags:
- Mentions & Citations
summary: List competitor mentions
x-llms-description: Paginated competitor mention records.
operationId: listCompetitorMentions
x-mcp-tool: list_competitor_mentions
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/Competitors'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Model'
- $ref: '#/components/parameters/CollectionId'
- $ref: '#/components/parameters/Prompt'
- $ref: '#/components/parameters/ListingFrom'
- $ref: '#/components/parameters/ListingTo'
- $ref: '#/components/parameters/Output'
- $ref: '#/components/parameters/CountryCode'
- $ref: '#/components/parameters/LanguageCode'
- $ref: '#/components/parameters/PromptType'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/Range'
responses:
'200':
description: Paginated competitor mentions
content:
application/json:
schema:
$ref: '#/components/schemas/CompetitorMentionsResponse'
/dimensions/competitor_citations:
get:
tags:
- Mentions & Citations
summary: List competitor citations
x-llms-description: Paginated competitor citation records.
description: Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
operationId: listCompetitorCitations
x-mcp-tool: list_competitor_citations
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/Competitors'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Model'
- $ref: '#/components/parameters/CollectionId'
- $ref: '#/components/parameters/Prompt'
- $ref: '#/components/parameters/ListingFrom'
- $ref: '#/components/parameters/ListingTo'
- $ref: '#/components/parameters/Output'
- $ref: '#/components/parameters/CountryCode'
- $ref: '#/components/parameters/LanguageCode'
- $ref: '#/components/parameters/PromptType'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/Range'
responses:
'200':
description: Paginated competitor citations
/dimensions/all_mentions:
get:
tags:
- Mentions & Citations
summary: List all mentions (brand + competitor)
x-llms-description: Unified brand + competitor mentions in one stream (actor_type field discriminates).
operationId: listAllMentions
x-mcp-tool: list_all_mentions
description: Unified mentions stream. Each record has an `actor_type` field (`project` or `competitor`) so the same payload covers both.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/Competitors'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Model'
- $ref: '#/components/parameters/CollectionId'
- $ref: '#/components/parameters/Prompt'
- $ref: '#/components/parameters/ListingFrom'
- $ref: '#/components/parameters/ListingTo'
- $ref: '#/components/parameters/Output'
- $ref: '#/components/parameters/CountryCode'
- $ref: '#/components/parameters/LanguageCode'
- $ref: '#/components/parameters/PromptType'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/Range'
responses:
'200':
description: Paginated mentions with actor_type discriminator
/dimensions/all_citations:
get:
tags:
- Mentions & Citations
summary: List all citations (brand + competitor)
x-llms-description: Unified brand + competitor citations in one stream (actor_type field discriminates).
operationId: listAllCitations
x-mcp-tool: list_all_citations
description: Unified citations stream with an `actor_type` field on each record. Includes visible citations and background source references; background references use position 0, meaning no visible rank.
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/Competitors'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Model'
- $ref: '#/components/parameters/CollectionId'
- $ref: '#/components/parameters/Prompt'
- $ref: '#/components/parameters/ListingFrom'
- $ref: '#/components/parameters/ListingTo'
- $ref: '#/components/parameters/Output'
- $ref: '#/components/parameters/CountryCode'
- $ref: '#/components/parameters/LanguageCode'
- $ref: '#/components/parameters/PromptType'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/Range'
responses:
'200':
description: Paginated citations with actor_type discriminator
components:
parameters:
PerPage:
name: per_page
in: query
schema:
type: integer
default: 20
maximum: 100
minimum: 1
Output:
name: output
in: query
schema:
type: string
enum:
- flat
- csv
description: Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. 'flat' returns the same metadata plus 'columns' and 'rows'; 'csv' returns those rows as text/csv. Errors are always returned as JSON.
ListingFrom:
name: from
in: query
schema:
type: string
format: date-time
description: Start of the window. Sent alone, the window runs from it to the end of today. A from later than to, or a window longer than 1,500 days, returns 422 ERR_INVALID_PARAM.
Prompt:
name: prompt
in: query
schema:
type: integer
minimum: 1
description: Filter by prompt ID. An id that is not a plain positive number, or that names no prompt of the project, returns 422 ERR_INVALID_PARAM.
ListingTo:
name: to
in: query
schema:
type: string
format: date-time
description: End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier. Sent without from, the window covers the 30 days that end on it.
PromptType:
name: prompt_type
in: query
schema:
type: string
description: 'One prompt type or a comma-separated list: informational, navigational, commercial, transactional'
CountryCode:
name: country_code
in: query
schema:
type: string
description: One ISO country code or a comma-separated list (e.g. US,GB,DE)
Range:
name: range
in: query
schema:
type: integer
description: Number of days to look back (alternative to from/to, which win when both are given). A value that is not a plain positive number returns 422 ERR_INVALID_PARAM, even beside from/to.
LanguageCode:
name: language_code
in: query
schema:
type: string
description: One ISO language code or a comma-separated list (e.g. en,es,de)
CollectionId:
name: collection_id
in: query
schema:
type: string
pattern: ^\d+(,\d+)*$
example: 12,34
description: 'One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.'
BrandKind:
name: brand_kind
in: query
schema:
type: string
enum:
- brand
- brand_other
- non_brand
description: 'Filter by brand kind: brand (own brand/products), brand_other (competitors/other brands), non_brand (generic, no brand named). For fair 1:1 brand-vs-competitor comparisons (visibility, share of voice), use non_brand: brand-focused prompts skew results toward the brand they name. The in-app Overview page applies non_brand by default.'
ProjectId:
name: project_id
in: query
required: true
schema:
type: integer
description: Project ID
Page:
name: page
in: query
schema:
type: integer
default: 1
minimum: 1
Model:
name: model
in: query
schema:
type: string
enum:
- chatgpt
- perplexity
- ai_mode
- ai_overview
- gemini
- copilot
- amazon_rufus
- claude
- grok
- deepseek
- naver_ai
- baidu_ai
- meta_ai
- naver_ai_tab
- qwen
- doubao
- bing_ai_mode
description: 'Filter by one AI model. It must be a model enabled for the API key''s user: an unknown value, or a model the user has not enabled, returns 422 ERR_INVALID_PARAM with the valid values in the message.'
Competitors:
name: competitors
in: query
schema:
type: string
description: Comma-separated competitor IDs (a malformed or unknown ID returns ERR_INVALID_PARAM)
schemas:
PaginatedEnvelope:
type: object
description: Envelope shared by the paginated listings; each listing adds its own data rows
required:
- project_id
- page
- per_page
- total
- request_id
properties:
project_id:
type: integer
page:
type: integer
per_page:
type: integer
total:
type: integer
description: Rows matching the filters across every page
request_id:
type: string
CitationsResponse:
allOf:
- $ref: '#/components/schemas/PaginatedEnvelope'
- type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/CitationRecord'
MentionsResponse:
allOf:
- $ref: '#/components/schemas/PaginatedEnvelope'
- type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/MentionRecord'
CompetitorMentionRecord:
type: object
required:
- id
- competitor_id
- name
- domain
- prompt_execution_id
- created_at
properties:
id:
type: integer
competitor_id:
type: integer
name:
type: string
description: The competitor's brand name
domain:
type: string
description: The competitor's bare domain
prompt_execution_id:
type: integer
created_at:
type: string
format: date-time
MentionRecord:
type: object
required:
- id
- name
- prompt_id
- prompt_execution_id
- created_at
properties:
id:
type: integer
name:
type: string
description: The project's brand name (its name when no brand name is set)
prompt_id:
type: integer
prompt_execution_id:
type: integer
created_at:
type: string
format: date-time
CompetitorMentionsResponse:
allOf:
- $ref: '#/components/schemas/PaginatedEnvelope'
- type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/CompetitorMentionRecord'
CitationRecord:
type: object
required:
- id
- name
- domain
- prompt_id
- prompt_execution_id
- url
- position
- created_at
properties:
id:
type: integer
name:
type: string
description: The project's brand name (its name when no brand name is set)
domain:
type:
- string
- 'null'
description: Host of the cited URL without www.; null when the URL has no parsable host
prompt_id:
type: integer
prompt_execution_id:
type: integer
url:
type: string
description: Normalized cited URL (tracking parameters and fragment removed)
position:
type:
- integer
- 'null'
description: Rank of the citation in the answer; 0 for a background source reference with no visible rank
created_at:
type: string
format: date-time
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: API key authentication. Keys are managed at https://llmpulse.ai/app/api_keys (Scale plan or above). Used for the REST API and as a headless option for /mcp. A key can be limited to one or several projects when it is created; the set cannot be changed later.
OAuth2:
type: oauth2
description: OAuth 2.1 with PKCE-S256 and Dynamic Client Registration. Accepted on /mcp only, available on every plan and during eligible trials. Discovery metadata at /.well-known/oauth-authorization-server.
flows:
authorizationCode:
authorizationUrl: https://api.llmpulse.ai/oauth/authorize
tokenUrl: https://api.llmpulse.ai/oauth/token
scopes:
mcp:read: Read data via MCP tools
mcp:write: Create resources via MCP write tools