WWatchLLM

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.

Acquisition

4 endpoints
get/api/v2/acquisition/conversion-intents

List captured public conversion intents.

get/api/v2/acquisition/conversion-intents/{id}

Get one captured public conversion intent.

get/api/v2/acquisition/free-tool-runs

List persisted public free-tool acquisition evidence.

get/api/v2/acquisition/free-tool-runs/{id}

Get one public free-tool acquisition run.

Actions

6 endpoints
get/api/v2/actions

List action recommendations. WatchLLM extension, not confirmed Promptwatch public REST parity.

get/api/v2/actions/{id}

Get one action recommendation with recent events. WatchLLM extension, not confirmed Promptwatch public REST parity.

patch/api/v2/actions/{id}

Update action status or schedule fields. WatchLLM extension, not confirmed Promptwatch public REST parity.

put/api/v2/actions/{id}

Update action status or schedule fields. WatchLLM extension, not confirmed Promptwatch public REST parity.

get/api/v2/actions/events

List action status and note events. WatchLLM extension, not confirmed Promptwatch public REST parity.

post/api/v2/actions/run-analysis

Run local daily action analysis for the project. WatchLLM extension, not confirmed Promptwatch public REST parity.

Analytics

2 endpoints
get/api/v2/analytics/brands/visibility-over-time

Get brand visibility over time.

get/api/v2/analytics/insights360/signals

Return 360 Insights page signals.

Authentication

1 endpoint
get/api/v2/validate

Validate an API key and return its scope.

Brand Book

4 endpoints
get/api/v2/brand-book

Get Brand Book memory and AI-agent defaults for the selected project.

patch/api/v2/brand-book

Update Brand Book memory and AI-agent defaults for the selected project.

put/api/v2/brand-book

Update Brand Book memory and AI-agent defaults for the selected project.

post/api/v2/brand-book/regenerate

Regenerate Brand Book memory from local project signals or a gated provider.

Brands

7 endpoints
get/api/v2/brands

List brands, competitors, ignored brands, and related entities.

post/api/v2/brands

Create a brand relationship.

patch/api/v2/brands/{id}

Update a brand relationship.

put/api/v2/brands/{id}

Update a brand relationship.

delete/api/v2/brands/{id}

Delete a non-SELF brand relationship.

post/api/v2/brands/{id}/tags

Attach tags to a brand relationship.

delete/api/v2/brands/{id}/tags/{tagId}

Detach a tag from a brand relationship.

Citations

7 endpoints
get/api/v2/citations

Return citation analytics for the selected project.

get/api/v2/citations/domains-by-llm

Return citation domains grouped by LLM.

get/api/v2/citations/domains-over-time

Return citation domains over time.

get/api/v2/citations/llm-sources

Return LLM citation source breakdown.

get/api/v2/citations/rank-analysis

Return citation rank analysis.

get/api/v2/citations/self-frequency

Return self-citation frequency.

get/api/v2/citations/top-pages

Return top cited pages.

Content

4 endpoints
get/api/v2/content

List generated content documents.

get/api/v2/content/{id}

Get a generated content document.

post/api/v2/content/{id}/stop

Stop an in-progress content document.

post/api/v2/content/create

Create or optimize a content document with the local content workflow.

Content Gap

6 endpoints
get/api/v2/content-gap/prompts

List prompts with content coverage metrics.

get/api/v2/content-gap/prompts/{promptId}/latest

Return latest content coverage for a prompt.

get/api/v2/content-gap/prompts/{promptId}/latest/recommendations

Return content gap recommendations for a prompt.

post/api/v2/content-gap/prompts/{promptId}/run

Run content gap analysis for a prompt.

post/api/v2/content-gap/run

Run content gap analysis for the selected project.

get/api/v2/content-gap/stats

Return content gap stats.

Crawler Analytics

4 endpoints
get/api/v2/analytics/crawlers/events

List crawler events.

get/api/v2/analytics/crawlers/top-crawlers

Return top AI crawlers by event volume.

get/api/v2/analytics/crawlers/top-pages

Return top crawler-hit pages.

get/api/v2/analytics/crawlers/trend

Return crawler traffic trend.

Integrations

1 endpoint
get/api/v2/integrations/live-preflights

List sanitized external live-preflight readiness states.

Knowledge Base

6 endpoints
get/api/v2/knowledge-sources

List Knowledge Base sources.

post/api/v2/knowledge-sources

Create a Knowledge Base source.

get/api/v2/knowledge-sources/{id}

Get a Knowledge Base source.

delete/api/v2/knowledge-sources/{id}

Delete a Knowledge Base source.

post/api/v2/knowledge-sources/{id}/retry

Retry Knowledge Base source indexing.

post/api/v2/knowledge-sources/search

Search Knowledge Base chunks.

Meta

1 endpoint
get/api/v2/meta

Return public REST v2 metadata, docs, and OpenAPI links.

Models

1 endpoint
get/api/v2/models

List active AI models available for monitor configuration.

Monitors

9 endpoints
get/api/v2/monitors

List monitors for the selected project.

post/api/v2/monitors

Create a monitor for the selected project.

get/api/v2/monitors/{id}

Get a monitor.

patch/api/v2/monitors/{id}

Update a monitor.

put/api/v2/monitors/{id}

Update a monitor.

delete/api/v2/monitors/{id}

Archive a monitor.

post/api/v2/monitors/{id}/run

Run a monitor with the local safe monitor runner.

get/api/v2/monitors/{id}/runs

List recent persisted runs for a monitor.

get/api/v2/monitors/{id}/runs/{runId}

Get one persisted monitor run with lifecycle events.

Offsite Mentions

3 endpoints
get/api/v2/offsite-mentions

List offsite mention rows. WatchLLM extension, not confirmed Promptwatch public REST parity.

get/api/v2/offsite-mentions/education

Return static education copy for the Offsite Mentions learn-more surface. WatchLLM extension.

get/api/v2/offsite-mentions/summary

Return offsite mention summary metrics. WatchLLM extension, not confirmed Promptwatch public REST parity.

Personas

6 endpoints
get/api/v2/personas

List personas for the selected project.

post/api/v2/personas

Create a persona.

get/api/v2/personas/{id}

Get a persona.

patch/api/v2/personas/{id}

Update a persona.

put/api/v2/personas/{id}

Update a persona.

delete/api/v2/personas/{id}

Delete a persona.

Projects

2 endpoints
get/api/v2/projects

List projects available to an organization-wide key.

post/api/v2/projects

Create a project with an organization-wide key.

Prompt Explorer

4 endpoints
get/api/v2/prompt-suggestion-runs

List prompt suggestion generation runs.

get/api/v2/prompt-suggestions

List saved prompt suggestions.

post/api/v2/prompt-suggestions/{id}/accept

Accept a prompt suggestion.

post/api/v2/prompt-suggestions/{id}/dismiss

Dismiss a prompt suggestion.

Prompts

12 endpoints
get/api/v2/prompts

List prompts with pagination and filters.

post/api/v2/prompts

Create a prompt.

get/api/v2/prompts/{id}

Get a prompt.

patch/api/v2/prompts/{id}

Update a prompt.

put/api/v2/prompts/{id}

Update a prompt.

delete/api/v2/prompts/{id}

Archive a prompt.

post/api/v2/prompts/{id}/tags

Attach tags to a prompt.

post/api/v2/prompts/bulk

Create prompts in bulk.

delete/api/v2/prompts/bulk

Delete prompts in bulk.

post/api/v2/prompts/bulk/activate

Activate prompts in bulk.

post/api/v2/prompts/bulk/deactivate

Deactivate prompts in bulk.

post/api/v2/prompts/bulk/tags

Attach tags to prompts in bulk.

Query Fanouts

5 endpoints
get/api/v2/llm-mentions

List LLM Mentions aggregate intelligence rows.

post/api/v2/llm-mentions/refresh-fixture

Refresh local or gated live LLM Mentions intelligence.

get/api/v2/llm-mentions/summary

Return LLM Mentions aggregate summary metrics.

get/api/v2/query-fanouts

List query fanouts.

get/api/v2/query-fanouts/{promptId}

Get query fanout detail.

Reports

15 endpoints
get/api/v2/reports

List report artifacts.

post/api/v2/reports

Create a local report artifact.

get/api/v2/reports/{id}/download

Download a report artifact.

get/api/v2/reports/csv-exports

List CSV exports.

post/api/v2/reports/csv-exports

Create a local CSV export artifact.

get/api/v2/reports/csv-exports/{id}/download

Download a CSV export artifact.

get/api/v2/reports/delivery-events

List report delivery events.

get/api/v2/reports/schedules

List report schedules.

post/api/v2/reports/schedules

Create a report schedule.

patch/api/v2/reports/schedules/{id}

Update a report schedule.

put/api/v2/reports/schedules/{id}

Replace report schedule fields.

delete/api/v2/reports/schedules/{id}

Delete a report schedule.

post/api/v2/reports/schedules/{id}/pause

Pause a report schedule.

post/api/v2/reports/schedules/{id}/resume

Resume a report schedule.

post/api/v2/reports/schedules/{id}/run

Run a report schedule now.

Responses

7 endpoints
get/api/v2/responses

List persisted LLM responses.

get/api/v2/responses/{id}

Get a persisted LLM response with citations and mentions.

get/api/v2/responses/competitors

Return top competitor mentions from responses.

get/api/v2/responses/mentions-time-series

Return brand mention time series from responses.

get/api/v2/responses/sentiment-distribution

Return response sentiment distribution.

get/api/v2/responses/sentiment-time-series

Return response sentiment time series.

get/api/v2/responses/summary

Return response summary analytics.

Sentiment

1 endpoint
get/api/v2/sentiment-time-series

Get sentiment time series data.

Shopping

6 endpoints
get/api/v2/shopping

Return shopping visibility overview.

get/api/v2/shopping/items

List shopping result items.

get/api/v2/shopping/items/{id}

Return one shopping result item with prompt and response context.

get/api/v2/shopping/merchants/top

Return top shopping merchants.

get/api/v2/shopping/product-position

Return shopping product position time series.

get/api/v2/shopping/products/top

Return top shopping products.

Sitemap

3 endpoints
post/api/v2/sitemap/discover

Discover sitemap URLs for the selected project.

get/api/v2/sitemap/progress

Return sitemap crawl progress.

get/api/v2/sitemap/urls

List discovered sitemap URLs.

Socials

4 endpoints
get/api/v2/socials/reddit

List Reddit social citation rows. WatchLLM extension, not confirmed Promptwatch public REST parity.

get/api/v2/socials/reddit/overview

Return Reddit social citation overview. WatchLLM extension, not confirmed Promptwatch public REST parity.

get/api/v2/socials/youtube

List YouTube social citation rows. WatchLLM extension, not confirmed Promptwatch public REST parity.

get/api/v2/socials/youtube/overview

Return YouTube social citation overview. WatchLLM extension, not confirmed Promptwatch public REST parity.

Tags

5 endpoints
get/api/v2/tags

List prompt tags for the selected project.

post/api/v2/tags

Create prompt tags.

patch/api/v2/tags/{id}

Rename a prompt tag.

put/api/v2/tags/{id}

Rename a prompt tag.

delete/api/v2/tags/{id}

Delete a prompt tag.

Team

2 endpoints
get/api/v2/team/invitations

List pending team invitations.

get/api/v2/team/members

List team members and project access.

Tracked Pages

3 endpoints
get/api/v2/tracked-pages

List tracked Page Tracker URLs with citation, visitor, and crawler rollups. WatchLLM extension, not confirmed Promptwatch public REST parity.

post/api/v2/tracked-pages

Add URLs to Page Tracker. WatchLLM extension for the observed Promptwatch trackedPages internal family.

delete/api/v2/tracked-pages/{id}

Remove a tracked Page Tracker URL.

Visibility

2 endpoints
get/api/v2/competitor-heatmap

Get competitor visibility heatmap data.

get/api/v2/visibility-time-series

Get brand visibility time series data.

Visitor Analytics

8 endpoints
get/api/v2/analytics/visitors/referrer-stats

Return AI visitor referrer comparison stats.

get/api/v2/analytics/visitors/top-browsers

Return top AI visitor browsers.

get/api/v2/analytics/visitors/top-devices

Return top AI visitor device types.

get/api/v2/analytics/visitors/top-locations

Return top AI visitor locations.

get/api/v2/analytics/visitors/top-pages

Return top AI visitor pages.

get/api/v2/analytics/visitors/top-sources

Return top AI visitor referrer sources.

get/api/v2/analytics/visitors/total

Return total AI visitor analytics.

get/api/v2/analytics/visitors/trend

Return AI visitor trend.