LLM Pulse Sources & Citation Intelligence API
Every URL extracted from AI responses, plus grouped URL, domain and host views, page-cache metadata, mention evidence inside cited pages, occurrences and sanitized cached content.
Every URL extracted from AI responses, plus grouped URL, domain and host views, page-cache metadata, mention evidence inside cited pages, occurrences and sanitized cached content.
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-sources-citation-intelligence-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 Sources & Citation Intelligence 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: Sources & Citation Intelligence
description: Every URL extracted from AI responses, plus grouped URL, domain and host views, page-cache metadata, mention evidence inside cited pages, occurrences and sanitized cached content.
paths:
/dimensions/sources:
get:
tags:
- Sources & Citation Intelligence
summary: List source URLs
x-llms-description: Paginated list of every URL extracted from AI responses with source_type classification.
operationId: listSources
x-mcp-tool: list_sources
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'
- name: source_type
in: query
schema:
type: string
enum:
- owned
- competitor
- third_party
description: Filter by source ownership. Owned and competitor matching honor the project's exact-subdomain setting. Any other value, including a differently cased one, returns ERR_INVALID_PARAM.
- $ref: '#/components/parameters/MentionFilter'
- $ref: '#/components/parameters/Competitors'
- $ref: '#/components/parameters/Output'
- $ref: '#/components/parameters/PromptType'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/Range'
responses:
'200':
description: Paginated sources
'422':
$ref: '#/components/responses/UnprocessableEntity'
/citation_intelligence/groups:
get:
tags:
- Sources & Citation Intelligence
summary: Grouped citation intelligence
x-llms-description: Grouped citation intelligence by URL / domain / host with filters and per-model breakdown; key reads one group and include_series adds its citations per period.
operationId: listCitationGroups
x-mcp-tool: list_citation_groups
description: 'Grouped citation intelligence by url / domain / host with per-model breakdown, citation rate, and avg citation position. Counts and citation rate include visible citations and background source references. Average position ignores rows with position=0. Owned and competitor source matching honor the project''s exact-subdomain setting. Filter vocabulary aligns with `source_type` returned by the API. Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is. Pass key to read one group; brand_kind filters by the brand focus of the prompts, like the source page. citation_series (with include_series=true) holds the answers citing the URL, domain or host under the same filters: granularity (day, week or month, from the account tracking cadence, with weeks when a daily account spans more than 60 days, starting on Monday), total (equal to total_responses), by_model (answers per AI model, largest first, which can include enabled models outside the seven the model filter accepts) and data, one { date, value } point per period that holds a filtered answer, so a zero means answers ran and none cited it. Periods date each answer by the day it was created in Europe/Madrid time, the date from and to filter.'
parameters:
- $ref: '#/components/parameters/ProjectId'
- name: view
in: query
schema:
type: string
enum:
- url
- domain
- host
default: url
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- name: order
in: query
schema:
type: string
enum:
- group_key
- total_responses
- total_citations
- citation_rate
- avg_citation_position
- first_seen_at
- last_seen_at
- name: direction
in: query
schema:
type: string
enum:
- asc
- desc
- $ref: '#/components/parameters/CitationModel'
- $ref: '#/components/parameters/CollectionId'
- $ref: '#/components/parameters/CountryCode'
- $ref: '#/components/parameters/LanguageCode'
- $ref: '#/components/parameters/Prompt'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/From'
- $ref: '#/components/parameters/To'
- name: key
in: query
schema:
type: string
description: 'Return only this group of the chosen view: a domain (view=domain), a host (view=host) or a cited URL exactly as listed (view=url). Domains and hosts match case-insensitively, without www. A view=url key is one raw URL, so its variants (a tracking parameter, a trailing slash) stay separate rows; GET /citation_intelligence/urls/{url_sha256} merges them, as the app does. No match returns an empty list (total 0), not an error.'
- name: include_series
in: query
schema:
type: boolean
default: false
description: Requires key, else 422 ERR_INVALID_PARAM. Adds citation_series to the group's row.
- name: query
in: query
schema:
type: string
- name: source_type
in: query
schema:
type: string
enum:
- owned
- competitor
- third_party
- social_media
- own_domain
- ugc
- background
- name: sentiment
in: query
schema:
type: string
enum:
- negative
- name: content_gap
in: query
schema:
type: string
enum:
- mentioned
- gap
description: 'mentioned: the cited page mentions your brand. gap: it mentions a competitor but not your brand. Only pages with usable content whose mention analysis has completed for this project match.'
responses:
'200':
description: Grouped citation intelligence
'422':
$ref: '#/components/responses/UnprocessableEntity'
/citation_intelligence/mentions_by_domain:
get:
tags:
- Sources & Citation Intelligence
summary: Mention share by citing domain
x-llms-description: For responses citing each given source domain, the brand-vs-competitor mention share (sums to 100% per domain).
operationId: getMentionsByCitingDomain
x-mcp-tool: get_mentions_by_citing_domain
description: For the responses where each given source domain is cited, returns the share of those responses that mention the brand vs each competitor (brand + competitors sum to 100% per domain). Pass multiple domains to get the whole matrix in one call.
parameters:
- $ref: '#/components/parameters/ProjectId'
- name: domains
in: query
required: true
schema:
type: array
items:
type: string
style: form
explode: false
description: 'Source domains to analyze: one domain or a comma-separated list, e.g. domains=gmac.com,educaweb.com. The bracket form domains[]=gmac.com&domains[]=educaweb.com is also accepted.'
- $ref: '#/components/parameters/CitationModel'
- $ref: '#/components/parameters/CollectionId'
- $ref: '#/components/parameters/CountryCode'
- $ref: '#/components/parameters/LanguageCode'
- $ref: '#/components/parameters/Prompt'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/From'
- $ref: '#/components/parameters/To'
responses:
'200':
description: Mention share per citing domain
'422':
$ref: '#/components/responses/UnprocessableEntity'
/citation_intelligence/urls/{url_sha256}:
get:
tags:
- Sources & Citation Intelligence
summary: Cited URL detail
x-llms-description: 'Per-URL detail: counts, citation rate, page-cache metadata, page mention evidence; include_series=true adds citations by AI model and per period.'
operationId: getCitedUrlDetail
x-mcp-tool: get_cited_url_details
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/UrlSha256'
- $ref: '#/components/parameters/CitationModel'
- $ref: '#/components/parameters/CollectionId'
- $ref: '#/components/parameters/CountryCode'
- $ref: '#/components/parameters/LanguageCode'
- $ref: '#/components/parameters/Prompt'
- $ref: '#/components/parameters/BrandKind'
- $ref: '#/components/parameters/From'
- $ref: '#/components/parameters/To'
- name: source_type
in: query
schema:
type: string
enum:
- owned
- competitor
- third_party
- social_media
- own_domain
- ugc
- background
- name: sentiment
in: query
schema:
type: string
enum:
- negative
- name: content_gap
in: query
schema:
type: string
enum:
- mentioned
- gap
description: 'mentioned: the cited page mentions your brand. gap: it mentions a competitor but not your brand. Only pages with usable content whose mention analysis has completed for this project match.'
- name: include_series
in: query
schema:
type: boolean
default: false
description: Adds citation_series. Without it the response is unchanged.
description: 'Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is. The filters narrow stats and citation_series alike. citation_series (with include_series=true) holds the answers citing the URL under the same filters: granularity (day, week or month, from the account tracking cadence, with weeks when a daily account spans more than 60 days, starting on Monday), total (equal to total_responses), by_model (answers per AI model, largest first, which can include enabled models outside the seven the model filter accepts) and data, one { date, value } point per period that holds a filtered answer, so a zero means answers ran and none cited it. Periods date each answer by the day it was created in Europe/Madrid time, the date from and to filter.'
responses:
'200':
description: URL-level intelligence
'404':
$ref: '#/components/responses/NotFound'
/citation_intelligence/urls/{url_sha256}/occurrences:
get:
tags:
- Sources & Citation Intelligence
summary: Cited URL occurrences
x-llms-description: Paginated occurrences of a cited URL across prompt executions.
operationId: listCitedUrlOccurrences
x-mcp-tool: list_cited_url_occurrences
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/UrlSha256'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
responses:
'200':
description: Paginated occurrences
'404':
$ref: '#/components/responses/NotFound'
/citation_intelligence/urls/{url_sha256}/content:
get:
tags:
- Sources & Citation Intelligence
summary: Cited URL cached content
x-llms-description: Sanitized cached page content for a cited URL plus mention evidence.
operationId: getCitedUrlContent
x-mcp-tool: get_cited_url_content
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/UrlSha256'
description: 'Unavailable page content keeps the cited URL and citation metrics. Page metadata/content and unknown brand_mentioned/competitor_mentioned return null. content_gap_status is content_unavailable (or missing_page_cache) without usable content, and mentions_not_processed when the page has usable content but its mention analysis has not completed for this project. Mention fields (brand_mentioned, competitor_mentioned, brand_position, brands, mentions, content_gap_status) describe the analysis for the requesting project: a page not yet analyzed for it returns null (never false) brand_mentioned, competitor_mentioned and brand_position, empty brands and mentions arrays and page_cache.mentions_processed false. page_cache.mentions_processed is true exactly when brand_mentioned is not null. An analyzed page keeps its last result until a newer analysis replaces it. status_code shows a saved successful response or observed 404/410; other crawl failures and error_message are hidden. last_crawled_at dates the saved copy. Domain/host crawled_urls_count counts usable copies; brand_mentioned_urls_count and competitor_mentioned_urls_count count only URLs analyzed for the project and are null when none is.'
responses:
'200':
description: Sanitized cached content + mention evidence
'404':
$ref: '#/components/responses/NotFound'
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.
CitationModel:
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. Only chatgpt, ai_overview, ai_mode, perplexity, gemini, naver_ai, baidu_ai, naver_ai_tab, qwen, doubao and bing_ai_mode are accepted: any other value, including another model enabled for the API key''s user, returns 422 ERR_INVALID_PARAM (invalid model). One of those eleven that the user has not enabled also returns 422 ERR_INVALID_PARAM, with the valid values in the message.'
UrlSha256:
name: url_sha256
in: path
required: true
schema:
type: string
pattern: ^[a-f0-9]{64}$
description: 64-character hex SHA-256 of the cited URL
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.'
From:
name: from
in: query
schema:
type: string
format: date-time
MentionFilter:
name: mention_filter
in: query
schema:
type: string
enum:
- mentions_you
- not_mentions_you
- mentions_competitor
- not_mentions_competitor
- you_and_competitor
- competitor_not_you
- you_not_competitor
- no_brands
description: 'Filter by which brands are mentioned, as a two-axis matrix (your brand x competitors): mentions_you / not_mentions_you, mentions_competitor / not_mentions_competitor, and the four combined cells you_and_competitor, competitor_not_you (a rival wins and you are absent), you_not_competitor, no_brands (no tracked brand appears, i.e. open space; on answers, finished answers only). Combine with ''competitors'' to narrow the competitor side to specific rivals; on a negative cell that reads ''none of these''. On /dimensions/sources it applies to the crawled content of each cited page instead of the answer text. The legacy value ''competitors_only'' is still accepted as an alias of competitor_not_you.'
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.'
To:
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.
Competitors:
name: competitors
in: query
schema:
type: string
description: Comma-separated competitor IDs (a malformed or unknown ID returns ERR_INVALID_PARAM)
responses:
UnprocessableEntity:
description: Invalid parameters
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: ERR_INVALID_PARAM
message: invalid metrics
request_id: abc-123
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: ERR_PROJECT_NOT_FOUND
message: project_not_found
request_id: abc-123
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- ERR_MISSING_AUTH
- ERR_INVALID_API_KEY
- ERR_REVOKED_API_KEY
- ERR_INSUFFICIENT_SCOPE
- ERR_INSUFFICIENT_PERMISSION
- ERR_KEY_PROJECT_SCOPED
- ERR_PLAN_REQUIRED
- ERR_INTEGRATION_UNAVAILABLE
- ERR_GENERATION_FAILED
- ERR_ACCOUNT_INACTIVE
- ERR_DRAFT_NOT_FOUND
- ERR_DRAFT_STATE
- ERR_PROJECT_NOT_FOUND
- ERR_NOT_FOUND
- ERR_SEARCH_CONSOLE_NOT_CONNECTED
- ERR_SEARCH_CONSOLE_ACCESS_REVOKED
- ERR_SEARCH_CONSOLE_UPSTREAM
- ERR_CMS_NOT_CONNECTED
- ERR_CMS_ACCESS_REVOKED
- ERR_CMS_REJECTED
- ERR_CMS_UPSTREAM
- ERR_AI_TRAFFIC_NOT_CONNECTED
- ERR_WEB_ANALYTICS_NOT_CONNECTED
- ERR_WEB_ANALYTICS_INVALID_QUERY
- ERR_WEB_ANALYTICS_ACCESS_REVOKED
- ERR_WEB_ANALYTICS_UPSTREAM
- ERR_AGENT_TRAFFIC_NOT_CONNECTED
- ERR_INVALID_PARAM
- ERR_INVALID_RANGE
- ERR_LIMIT_REACHED
- ERR_QUOTA_EXCEEDED
- ERR_STALE_CONTENT
- ERR_RATE_LIMITED
message:
type: string
meta:
type: object
description: Extra detail for some codes. A not-connected or access-revoked error from the Search Console, AI traffic, web analytics or agent traffic endpoints carries connect_url, the in-app page where the user connects or reconnects the source. A prompt write refused because a launched pitch project's prompts are fixed carries reason pitch_prompts_frozen.
request_id:
type: string
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