# Octolens

## Docs

- [Convert natural language to filters](https://octolens.com/docs/api-reference/ai/convert-natural-language-to-filters.md): Uses an LLM to convert a natural-language query (e.g. "posts from twitter influencers about pricing this week") into a structured filter object usable with /api/v2/mentions.
- [Mention volume over time](https://octolens.com/docs/api-reference/analytics/mention-volume-over-time.md): Counts mentions per bucket (day or hour) across the filter window, sorted chronologically.
- [Per-keyword breakdown](https://octolens.com/docs/api-reference/analytics/per-keyword-breakdown.md): Counts mentions per tracked keyword within the filter window. A post that matched multiple keywords contributes to each. Sorted by count desc.
- [Sentiment distribution](https://octolens.com/docs/api-reference/analytics/sentiment-distribution.md): Returns the count of mentions for each sentiment label (Positive, Neutral, Negative, unknown) within the filter window.
- [Source/platform breakdown](https://octolens.com/docs/api-reference/analytics/sourceplatform-breakdown.md): Counts mentions grouped by platform (reddit, twitter, linkedin, …) within the filter window, sorted by count desc.
- [Remove relevance feedback](https://octolens.com/docs/api-reference/feedback/remove-relevance-feedback.md)
- [Submit relevance feedback](https://octolens.com/docs/api-reference/feedback/submit-relevance-feedback.md): Submit thumbs-up / thumbs-down feedback on a mention. Updates Tinybird and adjusts relevance + tags so the feed reflects user intent immediately.
- [Create a feed](https://octolens.com/docs/api-reference/feeds/create-a-feed.md)
- [Delete a feed](https://octolens.com/docs/api-reference/feeds/delete-a-feed.md)
- [Get a feed](https://octolens.com/docs/api-reference/feeds/get-a-feed.md)
- [List feeds](https://octolens.com/docs/api-reference/feeds/list-feeds.md): Returns all feeds. A feed combines a saved filter (view) with optional notification destinations.
- [Update a feed](https://octolens.com/docs/api-reference/feeds/update-a-feed.md): Update any combination of name, icon, filters, default flag, or destinations. Omit `destinations` to leave them unchanged; pass an empty array to remove all destinations.
- [Get global filters](https://octolens.com/docs/api-reference/filters/get-global-filters.md): Returns all five org-wide filter lists (negative keywords, authors, subreddits, positive subreddits, repos).
- [Update global filters](https://octolens.com/docs/api-reference/filters/update-global-filters.md): Replace any of the five filter lists. Pass `[]` to clear a list; omit a field to leave it unchanged.
- [Accept a keyword suggestion](https://octolens.com/docs/api-reference/keywords/accept-a-keyword-suggestion.md): Apply the suggestion to the source keyword. Pass `modifiedValue` to override the suggested text.
- [Create a keyword](https://octolens.com/docs/api-reference/keywords/create-a-keyword.md): Start monitoring a new keyword. The keyword is immediately added to the data collection pipeline.
- [Delete a keyword](https://octolens.com/docs/api-reference/keywords/delete-a-keyword.md): Stops monitoring and removes the keyword. Views that reference only this keyword are also removed (cascade).
- [List keyword suggestions](https://octolens.com/docs/api-reference/keywords/list-keyword-suggestions.md): AI-generated tweaks for keyword config. Pass `keywordId` for per-keyword view, or omit for org-wide enriched list.
- [List keywords](https://octolens.com/docs/api-reference/keywords/list-keywords.md): Returns all keywords being tracked by the authenticated organization.
- [Reject keyword suggestion(s)](https://octolens.com/docs/api-reference/keywords/reject-keyword-suggestions.md): Pass `suggestionId` to reject one suggestion, or `keywordId` to reject all pending suggestions for a keyword.
- [Toggle keyword pause](https://octolens.com/docs/api-reference/keywords/toggle-keyword-pause.md): Toggles whether a keyword is actively collecting mentions.
- [Update a keyword](https://octolens.com/docs/api-reference/keywords/update-a-keyword.md)
- [Invite a member](https://octolens.com/docs/api-reference/members/invite-a-member.md): Sends an email invitation to join the authenticated organization. The invitee must accept the invitation from their email before appearing in the members list.
- [List organization members](https://octolens.com/docs/api-reference/members/list-organization-members.md): Lists all members of the authenticated organization.
- [Remove a member](https://octolens.com/docs/api-reference/members/remove-a-member.md): Removes a member from the organization. The member loses access immediately. You cannot remove the last remaining admin.
- [Export mentions](https://octolens.com/docs/api-reference/mentions/export-mentions.md): Export up to 50,000 mentions matching the given view and filters. Body shape matches `POST /api/v2/mentions` (v1-compatible) plus a `format` selector. Returns a downloadable file. Pass `format: "csv"` for a CSV or omit / `"json"` for a JSON file.
- [List mentions](https://octolens.com/docs/api-reference/mentions/list-mentions.md): Returns mentions scoped to the authenticated organization. Filter by keyword, source, sentiment, date range, or custom filter groups.
- [Update a mention](https://octolens.com/docs/api-reference/mentions/update-a-mention.md): Toggle engaged state, or update AI-judged relevance or sentiment. The `action` field selects the operation.
- [Get company profile](https://octolens.com/docs/api-reference/organization/get-company-profile.md): Returns the monitored company profile for the authenticated organization.
- [Get organization](https://octolens.com/docs/api-reference/organization/get-organization.md): Returns the authenticated workspace: name, plan, enabled platforms, lifecycle timestamps.
- [Get usage stats](https://octolens.com/docs/api-reference/organization/get-usage-stats.md): Mention and keyword counts for the current billing cycle, plus plan limits. Includes flex (usage-based) state when enabled.
- [Update company profile](https://octolens.com/docs/api-reference/organization/update-company-profile.md): Update any combination of the monitored company's fields (name, description, social handles, AI guidelines).
- [Update organization](https://octolens.com/docs/api-reference/organization/update-organization.md): Update editable workspace settings. Currently: `name` and `platforms`. Other fields (plan, billing, global filters, company profile, members) have their own endpoints.
- [API Reference](https://octolens.com/docs/api/overview.md): Use the Octolens REST API to query mentions, manage keywords, and pipe social listening data into your own apps, dashboards, and internal automations.
- [API Reference](https://octolens.com/docs/api/v2/overview.md): Use the Octolens REST API v2 to query mentions, manage keywords and feeds, run analytics, and pipe social listening data into your own apps, dashboards, and internal automations.
- [Introduction](https://octolens.com/docs/index.md): Learn how to use Octolens to monitor brand, competitor, and keyword mentions across Reddit, X, GitHub, podcasts, newsletters, and 9 more platforms.
- [AI Relevance & Tags](https://octolens.com/docs/learn/ai-relevance.md): How Octolens AI scores relevance and applies tags like Own Brand Mention, Competitors, Buy Intent, and Product Question, so you only see what matters.
- [Dashboard](https://octolens.com/docs/learn/dashboard.md): Mentions over time, plan and API/MCP usage, and a recent mentions feed — your morning glance at how the workspace is doing.
- [FAQs](https://octolens.com/docs/learn/faqs.md): Answers to common questions about Octolens: getting started, plans, keywords, platforms, destinations, team, developer access, and troubleshooting.
- [Mention Limits](https://octolens.com/docs/learn/mention-limits.md): Understand what counts toward your monthly mention quota, why your feed shows less than your counter, and how to reduce mention burn.
- [List of Newsletters](https://octolens.com/docs/learn/platforms/newsletter-list.md): The full list of 200+ newsletters Octolens monitors for your keywords, from Substacks and industry digests to developer-focused and B2B SaaS publications.
- [Tracked Platforms](https://octolens.com/docs/learn/platforms/overview.md): Overview of the platforms and data sources Octolens monitors for your keywords
- [Sentiment Analysis](https://octolens.com/docs/learn/sentiment.md): How Octolens classifies each mention as positive, neutral, or negative, and how to use sentiment in feeds, destinations, and the dashboard to spot brand risk early.
- [MCP Server](https://octolens.com/docs/mcp/overview.md): Connect Claude, ChatGPT, Cursor, and other AI agents to your Octolens mentions via MCP, so they can search, summarize, and act on social listening data.
- [Setup Guides](https://octolens.com/docs/mcp/setup-guides.md): Step-by-step guides to connect the Octolens MCP server to Claude Desktop, ChatGPT, Cursor, Cline, and other tools that support Model Context Protocol.
- [Use Cases](https://octolens.com/docs/mcp/use-cases.md): Real prompts and workflows for the Octolens MCP server. Turn brand mentions into weekly briefs, lead lists, support triage, and competitive intelligence.
- [Company Context](https://octolens.com/docs/quickstart/company-context.md): Tell Octolens about your business so the AI can judge which mentions are actually relevant to you.
- [Connect Slack](https://octolens.com/docs/quickstart/connect-slack.md): Connect your Slack workspace once, then send any feed to the channels you choose.
- [CSV Export](https://octolens.com/docs/quickstart/csv-export.md): Download your mentions as a CSV, including platform, author, sentiment, AI relevance score, and tags, for analysis in Excel, Sheets, or your own BI tool.
- [Destinations](https://octolens.com/docs/quickstart/destinations.md): Send any feed to email, Slack, or a webhook. Pick recipients and frequency per destination.
- [Feeds](https://octolens.com/docs/quickstart/feeds.md): Saved filters over your mentions. Use defaults like Brand Mentions and Buy Intent, or build your own. Send any feed to a destination.
- [Global Keyword Settings](https://octolens.com/docs/quickstart/global-keyword-settings.md): Account-wide filters. Cut noise across every keyword without editing them one at a time.
- [Keyword Settings](https://octolens.com/docs/quickstart/keyword-settings.md): Control what each keyword matches. Platforms, context, include/exclude rules, and match strictness.
- [Choosing Keywords](https://octolens.com/docs/quickstart/keywords.md): Pick keywords that surface real conversations, and learn how to add, pause, and delete them from the Keywords page.
- [Team Members](https://octolens.com/docs/quickstart/team-members.md): Invite teammates to your Octolens workspace, unlimited seats on every plan. Admins manage billing and invites, while members have full access to mentions.
- [Webhooks](https://octolens.com/docs/quickstart/webhooks.md): Pipe any feed into your own systems. Send new mentions as JSON to any URL.

## OpenAPI Specs

- [openapi](https://octolens.com/docs/api-reference/openapi.json)