# OpenLens

> Track brand visibility across the 7 AI platforms customers actually use.

## Docs

- [Deprecated: schedule lives on the project (410 Gone)](https://docs.openlens.com/api-reference/account/deprecated:-schedule-lives-on-the-project-410-gone.md): Use `/projects/{id}/schedule` instead.
- [List the caller's allowed platforms (read-only entitlement)](https://docs.openlens.com/api-reference/account/list-the-callers-allowed-platforms-read-only-entitlement.md)
- [Return the caller's effective rate limits and quotas](https://docs.openlens.com/api-reference/account/return-the-callers-effective-rate-limits-and-quotas.md)
- [Token usage and scraper spend, aggregated by model and call type](https://docs.openlens.com/api-reference/account/token-usage-and-scraper-spend-aggregated-by-model-and-call-type.md)
- [Top cited domains for the latest or selected run](https://docs.openlens.com/api-reference/citations/top-cited-domains-for-the-latest-or-selected-run.md)
- [Top topics where your own brand was mentioned, with the URLs cited](https://docs.openlens.com/api-reference/citations/top-topics-where-your-own-brand-was-mentioned-with-the-urls-cited.md)
- [Download a client-ready PDF visibility report](https://docs.openlens.com/api-reference/deliverables/download-a-client-ready-pdf-visibility-report.md): Renders a multi-page PDF for the chosen run. `runId` is required — the caller picks the run from `/reports/runs`. Optionally include the full per-prompt detail via `includePrompts=1`.
- [Recent run history for the report picker](https://docs.openlens.com/api-reference/deliverables/recent-run-history-for-the-report-picker.md)
- [AI-generated insight paragraph for one topic and run](https://docs.openlens.com/api-reference/metrics/ai-generated-insight-paragraph-for-one-topic-and-run.md): Synthesises visibility, attribute, and citation data for the topic into a 2–3 sentence actionable insight. Pass runId to read a specific completed run. Returns 404 when the project has no usable run or the topic is unknown.
- [Per-platform source behavior patterns for the latest or selected run](https://docs.openlens.com/api-reference/metrics/per-platform-source-behavior-patterns-for-the-latest-or-selected-run.md)
- [Time-series visibility for a brand or all competitors](https://docs.openlens.com/api-reference/metrics/time-series-visibility-for-a-brand-or-all-competitors.md)
- [Visibility scores for the latest usable or selected run](https://docs.openlens.com/api-reference/metrics/visibility-scores-for-the-latest-usable-or-selected-run.md): Default returns an array of `VisibilityScore` (one per brand). Pass runId to read a specific completed run. Use `type=topics` for a per-topic summary, `type=attributes&topicId=…` for a per-attribute breakdown, or `topicId=…` alone for a single topic's scores.
- [Analyze a brand or confirm a new project](https://docs.openlens.com/api-reference/onboarding/analyze-a-brand-or-confirm-a-new-project.md): Two-step onboarding over Server-Sent Events. `action: analyze` researches a URL and proposes competitors and topics. `action: confirm` creates the project and generates prompts.
- [Add a brand (competitor or own)](https://docs.openlens.com/api-reference/resources/add-a-brand-competitor-or-own.md)
- [Add a custom prompt-attribute value](https://docs.openlens.com/api-reference/resources/add-a-custom-prompt-attribute-value.md)
- [Archive a custom prompt-attribute by value](https://docs.openlens.com/api-reference/resources/archive-a-custom-prompt-attribute-by-value.md)
- [Archive a project (soft delete)](https://docs.openlens.com/api-reference/resources/archive-a-project-soft-delete.md)
- [Create a new project](https://docs.openlens.com/api-reference/resources/create-a-new-project.md)
- [Create a prompt under a topic](https://docs.openlens.com/api-reference/resources/create-a-prompt-under-a-topic.md)
- [Create a topic; prompts are generated in the background](https://docs.openlens.com/api-reference/resources/create-a-topic;-prompts-are-generated-in-the-background.md)
- [Delete a brand](https://docs.openlens.com/api-reference/resources/delete-a-brand.md)
- [Delete a topic and its prompts](https://docs.openlens.com/api-reference/resources/delete-a-topic-and-its-prompts.md)
- [Get the project's active platforms and the caller's entitlement](https://docs.openlens.com/api-reference/resources/get-the-projects-active-platforms-and-the-callers-entitlement.md)
- [Get the project's scan schedule](https://docs.openlens.com/api-reference/resources/get-the-projects-scan-schedule.md)
- [List allowed prompt-attribute values for the project](https://docs.openlens.com/api-reference/resources/list-allowed-prompt-attribute-values-for-the-project.md)
- [List brands in a project (your own + competitors)](https://docs.openlens.com/api-reference/resources/list-brands-in-a-project-your-own-+-competitors.md)
- [List prompts, optionally filtered by topic or fetched by id](https://docs.openlens.com/api-reference/resources/list-prompts-optionally-filtered-by-topic-or-fetched-by-id.md)
- [List topics in a project](https://docs.openlens.com/api-reference/resources/list-topics-in-a-project.md)
- [List your projects](https://docs.openlens.com/api-reference/resources/list-your-projects.md)
- [Rename or archive an existing custom prompt-attribute](https://docs.openlens.com/api-reference/resources/rename-or-archive-an-existing-custom-prompt-attribute.md)
- [Set the project's active platforms](https://docs.openlens.com/api-reference/resources/set-the-projects-active-platforms.md)
- [Soft-delete a prompt](https://docs.openlens.com/api-reference/resources/soft-delete-a-prompt.md)
- [Update a brand's aliases](https://docs.openlens.com/api-reference/resources/update-a-brands-aliases.md)
- [Update a project](https://docs.openlens.com/api-reference/resources/update-a-project.md)
- [Update prompt text, attributes, or active flag](https://docs.openlens.com/api-reference/resources/update-prompt-text-attributes-or-active-flag.md): Editing prompt text after results exist requires an explicit choice. The first call returns 409 with `requiresConfirmation: true` (plus `tracked` and `inFlightRun` hints); resend with `confirmClone: true` to clone-and-supersede (the original is deactivated with its history intact — recommended for t…
- [Update the project's scan schedule](https://docs.openlens.com/api-reference/resources/update-the-projects-scan-schedule.md)
- [Cancel the running run for a project](https://docs.openlens.com/api-reference/runs/cancel-the-running-run-for-a-project.md)
- [List a project's prompt run history](https://docs.openlens.com/api-reference/runs/list-a-projects-prompt-run-history.md): Returns paginated prompt runs with status, timestamps, platforms, and task totals. Use a completed run's id as runId on historical analytics reads.
- [Poll the status of a run](https://docs.openlens.com/api-reference/runs/poll-the-status-of-a-run.md): Pass `runId` for a specific run, or only `projectId` to fetch the project's most recent run. Returns `status: "none"` when no run exists yet.
- [Raw platform responses from the latest usable or selected run](https://docs.openlens.com/api-reference/runs/raw-platform-responses-from-the-latest-usable-or-selected-run.md): Returns enriched platform responses (one per prompt × platform) with brand mentions, citations, and attributes attached. Pass runId to read a specific completed run. Empty array when no usable run exists.
- [Start (or resume) a prompt run](https://docs.openlens.com/api-reference/runs/start-or-resume-a-prompt-run.md): Kicks off a fresh scan across the project's active platforms. Returns immediately with a `runId`. If a previous run was interrupted, this resumes it instead of starting a new one. Concurrent runs against the same project return 409.
- [Changelog](https://docs.openlens.com/changelog/overview.md): What's new in OpenLens.
- [How OpenLens sources data](https://docs.openlens.com/data-sources.md): Two channels, one schedule. What we measure and how.
- [Glossary](https://docs.openlens.com/glossary.md): One canonical definition for every OpenLens term, so the same word means the same thing on every page.
- [Dashboard deep-dive](https://docs.openlens.com/how-tos/dashboard-deep-dive.md): What the dashboard numbers actually mean and what to do about a bad result.
- [How-tos](https://docs.openlens.com/how-tos/overview.md): Task-oriented guides for the most common OpenLens workflows.
- [Introduction](https://docs.openlens.com/introduction.md): Track brand visibility across the AI platforms customers actually use.
- [AI Indexing](https://docs.openlens.com/manual/ai-indexing.md): Check whether AI platform retrieval surfaces can verify a client's exact pages.
- [AI Content Optimization](https://docs.openlens.com/manual/content-audit.md): Score how citable your content is for AI answers, and get a ranked worklist of fixes.
- [Dashboard](https://docs.openlens.com/manual/dashboard.md): The home view of a project: browse prompt runs, then open one for its visibility score and everything that explains it.
- [Agent](https://docs.openlens.com/manual/in-app-agent.md): A project-scoped assistant that analyzes your data, runs OpenLens tasks, and builds charts, tables, and documents in your workspace.
- [Onboarding](https://docs.openlens.com/manual/onboarding.md): Sign up, point at a website, run your first measurement.
- [Web UI manual](https://docs.openlens.com/manual/overview.md): What each surface of the OpenLens dashboard does and how to read it.
- [Prompt attributes](https://docs.openlens.com/manual/prompt-attributes.md): Labels on prompts that flow through the dashboard as filters.
- [Readiness](https://docs.openlens.com/manual/readiness.md): An audit that scores how discoverable and retrievable your site is to AI agents and crawlers.
- [Reports](https://docs.openlens.com/manual/reports.md): Client-ready PDF reports generated from a selected completed run.
- [Search & Traffic](https://docs.openlens.com/manual/search-and-traffic.md): Google Search Console and GA4 data next to your AI visibility. In the dashboard, in the agent, over MCP.
- [Settings](https://docs.openlens.com/manual/settings.md): Per-client and account configuration.
- [Topic performance](https://docs.openlens.com/manual/topic-performance.md): Per-topic deep-dive: AI recommendation, trend, platform breakdown, engine behavior, citations.
- [MCP server](https://docs.openlens.com/mcp/overview.md): Connect OpenLens to your AI agent. One OAuth sign-in, no API keys to copy.
- [MCP tools reference](https://docs.openlens.com/mcp/tools.md): Every public OAuth tool the OpenLens MCP server exposes, grouped by surface.
- [API keys and MCP](https://docs.openlens.com/organizations/api-keys-and-mcp.md): How personal and organization API keys differ, which organization's projects each reaches, and how MCP binds to your organization.
- [Client logins](https://docs.openlens.com/organizations/client-access.md): Give every client a live dashboard instead of a monthly PDF. Free and unlimited.
- [Organizations](https://docs.openlens.com/organizations/overview.md): Your agency's workspace: one org, all your clients, four roles.
- [Teams and seats](https://docs.openlens.com/organizations/teams-and-seats.md): Inviting teammates, what costs a seat, and what happens at the cap.
- [Limits and allowances](https://docs.openlens.com/pricing/limits.md): Every plan number in one table. Seats, clients, the credit pool, platforms, MCP and API calls.
- [Plans and pricing](https://docs.openlens.com/pricing/plans.md): What each tier includes, how the monthly credit pool works, and which plan fits your team.
- [Quickstart](https://docs.openlens.com/quickstart.md): Sign-up to first useful result in about 15 minutes.

## OpenAPI Specs

- [openapi](https://docs.openlens.com/api-reference/openapi.json)
- [openapi_spec](https://docs.openlens.com/openapi_spec.yaml)