API reference
The REST v2 reference below is generated from the checked-in OpenAPI surface shipped with this local WatchLLM app.
Every endpoint uses bearer API key authentication unless the route is explicitly public, such as /api/v2/meta. Project-scoped keys automatically resolve their project and ignore X-Project-Id. Organization-scoped keys can call organization-level routes directly, and must pass X-Project-Id for project-scoped routes.
Download the full machine-readable spec at /openapi-v2.json. Use /api/version for public, unauthenticated version and deployment metadata before integrating against authenticated REST endpoints.
List captured public conversion intents.
Get one captured public conversion intent.
List persisted public free-tool acquisition evidence.
Get one public free-tool acquisition run.
List action recommendations. WatchLLM extension, not confirmed reference REST parity.
Get one action recommendation with recent events. WatchLLM extension, not confirmed reference REST parity.
Update action status or schedule fields. WatchLLM extension, not confirmed reference REST parity.
Update action status or schedule fields. WatchLLM extension, not confirmed reference REST parity.
List action status and note events. WatchLLM extension, not confirmed reference REST parity.
Run local daily action analysis for the project. WatchLLM extension, not confirmed reference REST parity.
Get Brand Book memory and AI-agent defaults for the selected project.
Update Brand Book memory and AI-agent defaults for the selected project.
Update Brand Book memory and AI-agent defaults for the selected project.
Regenerate Brand Book memory from local project signals or a gated provider.
List brands, competitors, ignored brands, and related entities.
Create a brand relationship.
Update a brand relationship.
Update a brand relationship.
Delete a non-SELF brand relationship.
Attach tags to a brand relationship.
Detach a tag from a brand relationship.
Return citation analytics for the selected project.
Return citation domains grouped by LLM.
Return citation domains over time.
Return LLM citation source breakdown.
Return citation rank analysis.
Return self-citation frequency.
Return top cited pages.
List prompts with content coverage metrics.
Return latest content coverage for a prompt.
Return content gap recommendations for a prompt.
Run content gap analysis for a prompt.
Run content gap analysis for the selected project.
Return content gap stats.
List Knowledge Base sources.
Create a Knowledge Base source.
Get a Knowledge Base source.
Delete a Knowledge Base source.
Retry Knowledge Base source indexing.
Search Knowledge Base chunks.
List monitors for the selected project.
Create a monitor for the selected project.
Get a monitor.
Update a monitor.
Update a monitor.
Archive a monitor.
Run a monitor with the local safe monitor runner.
List recent persisted runs for a monitor.
Get one persisted monitor run with lifecycle events.
List offsite mention rows. WatchLLM extension, not confirmed reference REST parity.
Return static education copy for the Offsite Mentions learn-more surface. WatchLLM extension.
Return offsite mention summary metrics. WatchLLM extension, not confirmed reference REST parity.
List prompts with pagination and filters.
Create a prompt.
Get a prompt.
Update a prompt.
Update a prompt.
Archive a prompt.
Attach tags to a prompt.
Create prompts in bulk.
Delete prompts in bulk.
Activate prompts in bulk.
Deactivate prompts in bulk.
Attach tags to prompts in bulk.
List LLM Mentions aggregate intelligence rows.
Refresh local or gated live LLM Mentions intelligence.
Return LLM Mentions aggregate summary metrics.
List query fanouts.
Get query fanout detail.
List report artifacts.
Create a local report artifact.
Download a report artifact.
List CSV exports.
Create a local CSV export artifact.
Download a CSV export artifact.
List report delivery events.
List report schedules.
Create a report schedule.
Update a report schedule.
Replace report schedule fields.
Delete a report schedule.
Pause a report schedule.
Resume a report schedule.
Run a report schedule now.
List persisted LLM responses.
Get a persisted LLM response with citations and mentions.
Return top competitor mentions from responses.
Return brand mention time series from responses.
Return response sentiment distribution.
Return response sentiment time series.
Return response summary analytics.
Return shopping visibility overview.
List shopping result items.
Return one shopping result item with prompt and response context.
Return top shopping merchants.
Return shopping product position time series.
Return top shopping products.
List Reddit social citation rows. WatchLLM extension, not confirmed reference REST parity.
Return Reddit social citation overview. WatchLLM extension, not confirmed reference REST parity.
List YouTube social citation rows. WatchLLM extension, not confirmed reference REST parity.
Return YouTube social citation overview. WatchLLM extension, not confirmed reference REST parity.
List tracked Page Tracker URLs with citation, visitor, and crawler rollups. WatchLLM extension, not confirmed reference REST parity.
Add URLs to Page Tracker. WatchLLM extension for the observed the reference design trackedPages internal family.
Remove a tracked Page Tracker URL.
Return AI visitor referrer comparison stats.
Return top AI visitor browsers.
Return top AI visitor device types.
Return top AI visitor locations.
Return top AI visitor pages.
Return top AI visitor referrer sources.
Return total AI visitor analytics.
Return AI visitor trend.