# Chatobserver

## Docs

- [Billing and Usage](https://chatobserver.com/docs/administration/billing-and-usage.md): Understand how Chatobserver tracks plan usage, billing cycles, and workspace limits.
- [Team and Access](https://chatobserver.com/docs/administration/team-and-access.md): Manage workspace membership, invitations, roles, and API access.
- [Get brand visibility over time](https://chatobserver.com/docs/api-reference/analytics/get-brand-visibility-over-time.md): Retrieve brand visibility trends over time from analytics surfaces.
- [Get crawler activity trends](https://chatobserver.com/docs/api-reference/analytics/get-crawler-activity-trends.md): Retrieve crawler activity volume over time.
- [Get referrer stats](https://chatobserver.com/docs/api-reference/analytics/get-referrer-stats.md): Retrieve referrer host and session metrics.
- [Get sentiment time series](https://chatobserver.com/docs/api-reference/analytics/get-sentiment-time-series.md): Retrieve sentiment over time across tracked AI responses.
- [Get top browsers](https://chatobserver.com/docs/api-reference/analytics/get-top-browsers.md): Retrieve browser-family breakdowns for AI referral traffic.
- [Get top crawler pages](https://chatobserver.com/docs/api-reference/analytics/get-top-crawler-pages.md): Retrieve the pages most frequently visited by tracked crawlers.
- [Get top devices](https://chatobserver.com/docs/api-reference/analytics/get-top-devices.md): Retrieve device-category breakdowns for AI referral traffic.
- [Get top locations](https://chatobserver.com/docs/api-reference/analytics/get-top-locations.md): Retrieve top geographies for AI referral traffic.
- [Get top pages](https://chatobserver.com/docs/api-reference/analytics/get-top-pages.md): Retrieve landing pages receiving the most AI referral traffic.
- [Get top sources](https://chatobserver.com/docs/api-reference/analytics/get-top-sources.md): Retrieve source-level AI referral traffic metrics.
- [Get total visits](https://chatobserver.com/docs/api-reference/analytics/get-total-visits.md): Retrieve AI referral visit totals for the selected time range.
- [Get visitor trends](https://chatobserver.com/docs/api-reference/analytics/get-visitor-trends.md): Retrieve AI referral visit trends over time.
- [Validate API key](https://chatobserver.com/docs/api-reference/authentication/validate-api-key.md): Validate the presented Chatobserver API key and resolve the access scope that will be used for subsequent requests.
- [Create brand](https://chatobserver.com/docs/api-reference/brands/create-brand.md): Create a brand record for monitoring and analytics.
- [List brands](https://chatobserver.com/docs/api-reference/brands/list-brands.md): List brands configured for the resolved project.
- [Update brand](https://chatobserver.com/docs/api-reference/brands/update-brand.md): Update a brand record.
- [Get citation analytics](https://chatobserver.com/docs/api-reference/citations/get-citation-analytics.md): Retrieve aggregate citation analytics for the selected scope.
- [Get citation rank analysis](https://chatobserver.com/docs/api-reference/citations/get-citation-rank-analysis.md): Analyze which domains and URLs capture top citation positions.
- [Get domain citations over time](https://chatobserver.com/docs/api-reference/citations/get-domain-citations-over-time.md): Retrieve domain-level citation counts over time.
- [Get domains by LLM](https://chatobserver.com/docs/api-reference/citations/get-domains-by-llm.md): Retrieve the domains cited by each LLM or platform bucket.
- [Get LLM sources](https://chatobserver.com/docs/api-reference/citations/get-llm-sources.md): Retrieve LLM source breakdowns for citation activity.
- [Get self-citation frequency](https://chatobserver.com/docs/api-reference/citations/get-self-citation-frequency.md): Retrieve the rate at which the tracked brand cites its own domains.
- [Get top cited pages](https://chatobserver.com/docs/api-reference/citations/get-top-cited-pages.md): Retrieve the most cited URLs in the selected time range.
- [Get content gap stats](https://chatobserver.com/docs/api-reference/content-gap/get-content-gap-stats.md): Retrieve summary stats for content gap analysis.
- [Get content recommendations](https://chatobserver.com/docs/api-reference/content-gap/get-content-recommendations.md): Retrieve the latest recommendations for a prompt's coverage gaps.
- [Get latest content coverage](https://chatobserver.com/docs/api-reference/content-gap/get-latest-content-coverage.md): Retrieve the latest content coverage snapshot for a prompt.
- [List content gap prompts](https://chatobserver.com/docs/api-reference/content-gap/list-content-gap-prompts.md): List prompt coverage records used by content gap workflows.
- [List models](https://chatobserver.com/docs/api-reference/models/list-models.md): List the model and platform combinations available to the project. The current preview derives this catalog from observed prompt-run metadata plus configured prompt platforms, so `family` values may still be `unknown`.
- [Create monitor](https://chatobserver.com/docs/api-reference/monitors/create-monitor.md): Create a new monitor definition.
- [Delete monitor](https://chatobserver.com/docs/api-reference/monitors/delete-monitor.md): Delete a monitor definition.
- [Get monitor](https://chatobserver.com/docs/api-reference/monitors/get-monitor.md): Retrieve a single monitor definition.
- [List monitors](https://chatobserver.com/docs/api-reference/monitors/list-monitors.md): List monitors configured for the resolved project.
- [Update monitor](https://chatobserver.com/docs/api-reference/monitors/update-monitor.md): Update an existing monitor definition.
- [Create persona](https://chatobserver.com/docs/api-reference/personas/create-persona.md): Create a persona for prompt targeting and analysis slices.
- [Delete persona](https://chatobserver.com/docs/api-reference/personas/delete-persona.md): Delete a persona.
- [Get persona](https://chatobserver.com/docs/api-reference/personas/get-persona.md): Retrieve a single persona.
- [List personas](https://chatobserver.com/docs/api-reference/personas/list-personas.md): List personas available to the resolved project.
- [Update persona](https://chatobserver.com/docs/api-reference/personas/update-persona.md): Update a persona.
- [Create project](https://chatobserver.com/docs/api-reference/projects/create-project.md): Create a new Chatobserver project.
- [List projects](https://chatobserver.com/docs/api-reference/projects/list-projects.md): List the projects visible to the authenticated key. The current preview resolves one workspace-backed project per workspace-scoped key while the fuller multi-project model remains in development.
- [Activate prompts](https://chatobserver.com/docs/api-reference/prompts/activate-prompts.md): Activate multiple prompts.
- [Attach tags to prompt](https://chatobserver.com/docs/api-reference/prompts/attach-tags-to-prompt.md): Attach one or more tags to a prompt.
- [Bulk attach tags](https://chatobserver.com/docs/api-reference/prompts/bulk-attach-tags.md): Attach one or more tags to multiple prompts.
- [Bulk create prompts](https://chatobserver.com/docs/api-reference/prompts/bulk-create-prompts.md): Create multiple prompts in a single request.
- [Bulk delete prompts](https://chatobserver.com/docs/api-reference/prompts/bulk-delete-prompts.md): Delete multiple prompts in a single request.
- [Create prompt](https://chatobserver.com/docs/api-reference/prompts/create-prompt.md): Create a new prompt.
- [Deactivate prompts](https://chatobserver.com/docs/api-reference/prompts/deactivate-prompts.md): Deactivate multiple prompts.
- [Delete prompt](https://chatobserver.com/docs/api-reference/prompts/delete-prompt.md): Delete a prompt record.
- [Get prompt](https://chatobserver.com/docs/api-reference/prompts/get-prompt.md): Retrieve a single prompt.
- [List prompts](https://chatobserver.com/docs/api-reference/prompts/list-prompts.md): Returns a cursor-paginated list of prompts for the authenticated workspace, including schedule metadata and prompt status.
- [Rerun prompt](https://chatobserver.com/docs/api-reference/prompts/rerun-prompt.md): Queue an immediate rerun for a prompt.
- [Update prompt](https://chatobserver.com/docs/api-reference/prompts/update-prompt.md): Update a prompt definition.
- [List query fanouts](https://chatobserver.com/docs/api-reference/query-fanouts/list-query-fanouts.md): List query fanouts captured for response analysis.
- [Get mentions time series](https://chatobserver.com/docs/api-reference/responses/get-mentions-time-series.md): Retrieve a response-level mention series over time. The current preview does not yet support first-class `brandId` filtering.
- [Get response](https://chatobserver.com/docs/api-reference/responses/get-response.md): Retrieve a single AI response with citations and analysis details.
- [Get response summary](https://chatobserver.com/docs/api-reference/responses/get-response-summary.md): Retrieve high-level response summary metrics. The current preview does not yet support first-class `brandId` filtering.
- [Get sentiment distribution](https://chatobserver.com/docs/api-reference/responses/get-sentiment-distribution.md): Retrieve the distribution of response sentiment labels.
- [Get sentiment over time](https://chatobserver.com/docs/api-reference/responses/get-sentiment-over-time.md): Retrieve the response sentiment mix over time.
- [Get top competitors](https://chatobserver.com/docs/api-reference/responses/get-top-competitors.md): Retrieve the most frequently co-mentioned competitors across responses.
- [List responses](https://chatobserver.com/docs/api-reference/responses/list-responses.md): List AI responses captured for the resolved project. The current preview exposes prompt runs as responses and may return `unknown` for model values when provider model metadata is not yet persisted consistently.
- [Get share of voice comparison](https://chatobserver.com/docs/api-reference/share-of-voice/get-share-of-voice-comparison.md): Compare share of voice across tracked brands or competitors.
- [Get share of voice time series](https://chatobserver.com/docs/api-reference/share-of-voice/get-share-of-voice-time-series.md): Retrieve share of voice as a time series.
- [Get sitemap crawl progress](https://chatobserver.com/docs/api-reference/sitemap/get-sitemap-crawl-progress.md): Retrieve the current sitemap crawl and ingestion progress.
- [Get sources overview](https://chatobserver.com/docs/api-reference/sources/get-sources-overview.md): Returns dashboard-style source rollups, daily totals, top domains, and insights for the authenticated workspace.
- [List source domains](https://chatobserver.com/docs/api-reference/sources/list-source-domains.md): Returns cursor-paginated domain totals with mention counts, citation counts, and linked prompts.
- [Create tags](https://chatobserver.com/docs/api-reference/tags/create-tags.md): Create one or more tags.
- [Delete tag](https://chatobserver.com/docs/api-reference/tags/delete-tag.md): Delete a tag from the resolved project.
- [List tags](https://chatobserver.com/docs/api-reference/tags/list-tags.md): List tags available in the resolved project.
- [Rename tag](https://chatobserver.com/docs/api-reference/tags/rename-tag.md): Rename an existing tag.
- [Get usage summary](https://chatobserver.com/docs/api-reference/usage/get-usage-summary.md): Return the current prompt and analysis usage snapshot, plus optional historical usage periods for the authenticated workspace-backed project.
- [API v2 Authentication](https://chatobserver.com/docs/api-reference/v2/authentication.md): Authenticate Chatobserver API v2 requests with workspace-scoped or organization-scoped API keys and optional project selection headers.
- [API v2 Conventions](https://chatobserver.com/docs/api-reference/v2/conventions.md): Learn the common envelope, pagination, timestamp, tenancy, and mutation patterns used throughout Chatobserver API v2.
- [API v2 Overview](https://chatobserver.com/docs/api-reference/v2/overview.md): Explore the next-generation Chatobserver API surface for projects, monitors, prompts, responses, citations, visibility, analytics, and content gap workflows.
- [API v2 Rate Limits](https://chatobserver.com/docs/api-reference/v2/rate-limits.md): Understand the intended rate-limit behavior for Chatobserver API v2 and how clients should handle throttling.
- [Get competitor heatmap](https://chatobserver.com/docs/api-reference/visibility/get-competitor-heatmap.md): Retrieve competitor pressure cells across prompts and brands.
- [Get visibility time series](https://chatobserver.com/docs/api-reference/visibility/get-visibility-time-series.md): Retrieve brand visibility metrics over time.
- [List visibility domain rollups](https://chatobserver.com/docs/api-reference/visibility/list-visibility-domain-rollups.md): Return daily visibility rollups by root domain and prompt for the resolved project.
- [Quickstart](https://chatobserver.com/docs/getting-started/quickstart.md): Set up a workspace, create your first prompts, and start collecting AI visibility data.
- [Workspace Tour](https://chatobserver.com/docs/getting-started/workspace-tour.md): A practical overview of the main Chatobserver product surfaces.
- [Introduction](https://chatobserver.com/docs/index.md): Chatobserver helps teams monitor how AI assistants mention brands, competitors, and sources over time.
- [AI Referrals](https://chatobserver.com/docs/platform/ai-referrals.md): AI Referrals docs are being rebuilt. This page is temporarily in maintenance mode.
- [Alerts](https://chatobserver.com/docs/platform/alerts.md): Alerts docs are being rebuilt. This page is temporarily in maintenance mode.
- [Chat](https://chatobserver.com/docs/platform/chat.md): Chat docs are being rebuilt. This page is temporarily in maintenance mode.
- [Competitors](https://chatobserver.com/docs/platform/competitors.md): Competitors docs are being rebuilt. This page is temporarily in maintenance mode.
- [Crawler Logs](https://chatobserver.com/docs/platform/crawler-logs.md): Crawler Logs docs are being rebuilt. This page is temporarily in maintenance mode.
- [Groups](https://chatobserver.com/docs/platform/groups.md): Groups docs are being rebuilt. This page is temporarily in maintenance mode.
- [Integrations](https://chatobserver.com/docs/platform/integrations.md): Integrations docs are being rebuilt. This page is temporarily in maintenance mode.
- [Overview](https://chatobserver.com/docs/platform/overview.md): Overview docs are being rebuilt. This page is temporarily in maintenance mode.
- [Personas](https://chatobserver.com/docs/platform/personas.md): Personas docs are being rebuilt. This page is temporarily in maintenance mode.
- [Prompts](https://chatobserver.com/docs/platform/prompts.md): How prompts are created, grouped, scheduled, and maintained in Chatobserver.
- [Reports](https://chatobserver.com/docs/platform/reports.md): Build, organize, and share stakeholder-ready views of Chatobserver data.
- [Runs](https://chatobserver.com/docs/platform/runs.md): How prompt executions are tracked, filtered, and interpreted.
- [Sentiment](https://chatobserver.com/docs/platform/sentiment.md): Sentiment docs are being rebuilt. This page is temporarily in maintenance mode.
- [Settings](https://chatobserver.com/docs/platform/settings.md): Settings docs are being rebuilt. This page is temporarily in maintenance mode.
- [Sources](https://chatobserver.com/docs/platform/sources.md): How Chatobserver organizes domains, citations, mentions, and prompt-level source activity.

## OpenAPI Specs

- [chatobserver-v2.openapi](https://chatobserver.com/docs/openapi/chatobserver-v2.openapi.yaml)
- [chatobserver-v1.openapi](https://chatobserver.com/docs/openapi/chatobserver-v1.openapi.yaml)
- [openapi](https://chatobserver.com/docs/api-reference/openapi.json)