Promptwatch
API integration

list_all_promptwatch_auth_validates

Validate the API key and return associated project and organization details. For organization-level keys, optionally provide X-Project-Id header to validate access to a specific project.

list_all_promptwatch_brands

Get all brands for the project. Favicons are available from a separate public endpoint (not part of API v2). See Brand icons.

create_a_promptwatch_brand

Create or connect a brand to the project.

update_a_promptwatch_brand_by_id

Update brand relationship.

list_all_promptwatch_brands_visibility_over_times

Get brand visibility over time.

list_all_promptwatch_citations

Get citation analytics including top cited domains, URLs, and authority metrics

promptwatch_citations_list_domains_by_llm

Get domain citations grouped by LLM source

promptwatch_citations_list_domains_over_time

Get domain citation frequency over time for top domains

promptwatch_citations_list_llm_sources

Get top LLM sources with citation statistics

promptwatch_citations_list_rank_analysis

Get citation rank analysis for your domain over time

promptwatch_citations_list_self_frequency

Get self-citation frequency over time (citations pointing to your own domain)

promptwatch_citations_list_top_pages

Get top cited pages with average rank

list_all_promptwatch_competitor_heatmaps

Get competitor visibility heatmap data showing visibility percentages across different models and competitors. Returns a structured matrix ready for heatmap visualization.

list_all_promptwatch_content_gap_stats

Get aggregate content coverage statistics for the project

list_all_promptwatch_contents

Paginated list of content documents for the project. Filter by mode (CREATE or OPTIMIZE) and/or status (PENDING, IN_PROGRESS, COMPLETED, FAILED, STOPPED) to narrow results. Each row includes status, mode, title, linked prompt id/text, and timestamps but omits the full markdown content body — use GET /content/:id for the complete document. Pagination uses size (page length) with total/page/totalPages in the response, matching other v2 list endpoints.

get_single_promptwatch_content_by_id

Returns the full detail of a content document including its current generation status, content body (when available), linked prompt, and timestamps. Use this endpoint to poll after POST /content/create. Status progresses as: PENDING (queued) → IN_PROGRESS (AI generating) → COMPLETED | FAILED | STOPPED. During IN_PROGRESS, title and content fields may be present but are incomplete — content streams in progressively and should not be treated as final. Both fields are null while PENDING and only fully reliable once status reaches COMPLETED. STOPPED documents may retain partial content. The failedAt/failedReason fields are populated when status is FAILED; stoppedAt is set when STOPPED.

create_a_promptwatch_content

Starts asynchronous AI content generation in one of two modes: CREATE (generate new content from a prompt) or OPTIMIZE (rewrite an existing page URL for better AI visibility). Returns the document id and PENDING status immediately — the document then transitions through IN_PROGRESS while the AI generates content, and reaches a terminal state of COMPLETED (success), FAILED (error), or STOPPED (manually cancelled). Poll GET /content/:id to track progress. Requires project API key (or org key + X-Project-Id). Prerequisites: GET /prompts (promptId), GET /personas (personaId); optional recommendation ids from content-gap endpoints.

list_all_promptwatch_crawlers_events

List individual AI crawler HTTP requests (event log) for the project, with pagination and filters. Same data as the in-product crawler activity explorer.

list_all_promptwatch_crawlers_top_pages

Get top pages requested by crawlers

list_all_promptwatch_crawlers_trends

Get crawler activity trends over time. If the crawlers query parameter is omitted, the response includes all known AI crawler types that have data in the selected range (the server queries the full set of allowed crawler keys).

list_all_promptwatch_models

List all available LLM models supported by Promptwatch

list_all_promptwatch_monitors

Get all active monitors for the current project with average visibility and response counts in a date range

get_single_promptwatch_monitor_by_id

Get a single monitor by ID with full details

create_a_promptwatch_monitor

Create a new monitor

delete_a_promptwatch_monitor_by_id

Soft-delete a monitor

update_a_promptwatch_monitor_by_id

Update an existing monitor

create_a_promptwatch_persona

Create a new persona for the project

get_single_promptwatch_persona_by_id

Get a specific persona by ID

update_a_promptwatch_persona_by_id

Update an existing persona

list_all_promptwatch_personas

List all personas for the project.

delete_a_promptwatch_persona_by_id

Delete a persona by its ID.

list_all_promptwatch_projects

List all projects for the organization.

create_a_promptwatch_project

Create a new project (requires org-level API key, X-Project-Id header NOT required)

list_all_promptwatch_prompts

Get paginated list of prompts with search and filtering options

get_single_promptwatch_prompt_by_id

Get a single prompt by ID

update_a_promptwatch_prompt_by_id

Update a prompt's type and intent

delete_a_promptwatch_prompt_by_id

Soft-delete a prompt by ID

promptwatch_prompts_bulk_create

Create multiple prompts in a single request (max 100)

promptwatch_prompts_bulk_delete

Soft-delete multiple prompts by IDs

promptwatch_prompts_bulk_activate

Activate multiple prompts

promptwatch_prompts_bulk_deactivate

Deactivate multiple prompts

promptwatch_prompts_attach_tag

Attach tags to a prompt (creates tags if they don't exist)

promptwatch_prompts_bulk_tags

Attach tags to multiple prompts (creates tags if they don't exist)

create_a_promptwatch_prompt

Create a new prompt with specified text, type, and monitor association

list_all_promptwatch_query_fanouts

Get paginated list of prompts with extracted ChatGPT query fanout keywords

list_all_promptwatch_responses

Get paginated list of responses with search and filtering options

get_single_promptwatch_response_by_id

Get a single response by ID with full citations

promptwatch_responses_list_competitors

Get top competitor mentions from LLM responses

promptwatch_responses_list_mentions_time_series

Get brand and competitor mentions over time

promptwatch_responses_list_sentiment_distribution

Get sentiment distribution of LLM responses

promptwatch_responses_list_sentiment_time_series

Get sentiment changes over time for brand mentions

promptwatch_responses_list_summary

Get response summary including total responses and brand mentions

list_all_promptwatch_sentiment_time_series

Get brand sentiment time series data

list_all_promptwatch_sitemap_progreses

Get sitemap crawl progress with counts, percentage, HTTP status breakdown, and crawl health score.

list_all_promptwatch_tags

Get all tags for the project with prompt counts

create_a_promptwatch_tag

Create one or more tags for the project

delete_a_promptwatch_tag_by_id

Delete a tag and remove it from all prompts

update_a_promptwatch_tag_by_id

Rename an existing tag

list_all_promptwatch_visibility_time_series

Get brand visibility time series data

list_all_promptwatch_visitors_referrer_stats

Get referrer comparison stats with period-over-period changes

list_all_promptwatch_visitors_top_browsers

Get top browsers by visitor count

list_all_promptwatch_visitors_top_devices

Get top devices by visitor count

list_all_promptwatch_visitors_top_locations

Get top geographic locations by visitor count

list_all_promptwatch_visitors_top_pages

Get top pages by visitor count

list_all_promptwatch_visitors_top_sources

Get top referrer sources by visitor count

list_all_promptwatch_visitors_totals

Get total visitor counts over time

list_all_promptwatch_visitors_trends

Get visitor trends grouped by referrer

list_all_promptwatch_content_gap_prompts

List content_gap_prompts in Promptwatch. Returns id, prompt, type, intent, languageCode, createdAt, responseCount, and latestContentGap with score, date, and sitemap details. Date range cannot exceed 60 days.

list_all_promptwatch_latest_content_coverage

Get the latest content coverage for a prompt in Promptwatch. Requires prompt_id. Returns fields such as id, contentCoverageScore, explanation, report, sources, queryFanouts, sitemapTotalUrls, sitemapCrawledUrls, createdAt, and recommendations.