# PeakMetrics

## Docs

- [Returns an access token](https://docs.peakmetrics.com/api-reference/authorization/returns-an-access-token.md)
- [Add mentions](https://docs.peakmetrics.com/api-reference/custom-channels/add-mentions.md): Add mentions to a custom channel. _All_ mentions must pass validation before being accepted for ingestion, after which they are queued up for asynchronous processing.
- [Custom channels](https://docs.peakmetrics.com/api-reference/custom-channels/custom-channels.md): Returns custom channels that you have access to. Custom channels allow access to additional data sources beyond the standard channels.
- [Add enrichments](https://docs.peakmetrics.com/api-reference/custom-enrichments/add-enrichments.md): Pushes custom enrichment values onto existing mentions. You can enrich both standard mentions and custom channel mentions, including historical mentions already stored in the platform.
- [Custom enrichments](https://docs.peakmetrics.com/api-reference/custom-enrichments/custom-enrichments.md): Custom enrichments let you push external context about mentions into PeakMetrics, attached to individual mentions and used alongside all other mention metadata across the platform. Once written, enrichment values feed into narrative analysis, workspace summaries, and notifications, and are available…
- [Available mention filters](https://docs.peakmetrics.com/api-reference/workspaces/available-mention-filters.md): Returns the available filters and their options for querying workspace data. When filtering other endpoints, use each filter's `key`=`value` in the query string. Enum filters use the format `key[]=value` repeated for each value.
- [Mention count distribution](https://docs.peakmetrics.com/api-reference/workspaces/mention-count-distribution.md): Returns mention counts broken down by a specified dimension. Use the `group_by` parameter to select which dimension to distribute by (e.g., channels, authors, domains, or languages).
- [Mention volume over time](https://docs.peakmetrics.com/api-reference/workspaces/mention-volume-over-time.md): Returns mention volume aggregated into time buckets over the requested date range. Use the optional `group_by` parameter to add a secondary breakdown within each bucket by any filterable dimension (e.g., channel, language, bot rating, smart category, etc.).
- [Mentions](https://docs.peakmetrics.com/api-reference/workspaces/mentions.md): A mention is the fundamental data unit in PeakMetrics—a piece of content written by an author, promoted by a publisher, and released on a domain as part of a channel. Typically, this is a news article or social media post.
- [Narratives](https://docs.peakmetrics.com/api-reference/workspaces/narratives.md): Narratives are AI-powered clusters of related mentions that share common themes or storylines. PeakMetrics' narrative clustering algorithms distill thousands of mentions into easily digestible narratives, helping you quickly understand key themes without manual analysis.
- [Workspaces](https://docs.peakmetrics.com/api-reference/workspaces/workspaces.md): Get a list of your workspaces. You'll use workspace IDs to fetch narrative intelligence data.
- [Changelog](https://docs.peakmetrics.com/api/changelog.md)
- [Example Workflows](https://docs.peakmetrics.com/api/example-workflows.md): Common narrative intelligence use cases utilizing the PeakMetrics API
- [Introduction](https://docs.peakmetrics.com/api/introduction.md): PeakMetrics API v2.0 - Access media intelligence data programmatically
- [SSO Setup](https://docs.peakmetrics.com/help/account/setting-up-single-sign-on-sso.md): Allow your team to log in to PeakMetrics using Single Sign-On (SSO)
- [Custom AI Summaries](https://docs.peakmetrics.com/help/building-reports/custom-ai-generated-summaries-in-peakmetrics.md): Tailor your AI-generated summaries to fit your specific needs.
- [Atlas AI Reports](https://docs.peakmetrics.com/help/building-reports/peakmetrics-atlas-ai-powered-report-generation-conversational-intelligence.md): Generate AI-powered PDF slide reports instantly within your workspace.
- [Reality Defender Deepfake Detection](https://docs.peakmetrics.com/help/enrichments-and-integrations/reality-defender-deepfake-detection.md): Scan media content for authenticity using AI-powered deepfake detection focused on manipulated faces and text.
- [Smart Categories AI Classification](https://docs.peakmetrics.com/help/enrichments-and-integrations/smart-categories-ai-powered-classification.md): Automatically tag mentions in your workspace using AI-driven prompts for seamless content classification.
- [Social Engagement Metrics](https://docs.peakmetrics.com/help/enrichments-and-integrations/social-engagement-metrics.md): Track interactions across platforms with standardized engagement metrics to compare performance and spot trends.
- [Tracking Tweet Engagement](https://docs.peakmetrics.com/help/enrichments-and-integrations/tracking-tweet-engagement.md): Track live engagement for individual Tweets and watch how views, reposts, favorites, and replies evolve over time.
- [Reach Metrics](https://docs.peakmetrics.com/help/enrichments-and-integrations/understanding-reach-in-peakmetrics.md): Estimate the potential visibility of online content with Reach metrics across news, social media, and more.
- [Advanced Data Dictionary](https://docs.peakmetrics.com/help/everything-boolean/advanced-data-dictionary.md): Advanced Data Dictionary
- [Advanced Guide to Boolean Searches](https://docs.peakmetrics.com/help/everything-boolean/advanced-guide-to-boolean-searches.md): There's more to Boolean that just AND, OR, and NOT!
- [Twitter List Workspaces](https://docs.peakmetrics.com/help/everything-boolean/create-a-workspace-with-a-twitter-list.md): Create an alert to capture mentions directly from a cohort of Twitter Users.
- [Creating Boolean Queries](https://docs.peakmetrics.com/help/everything-boolean/creating-boolean-queries.md): PeakMetrics supports a wide variety of advanced search tools. Here we provide information about what search tools you have access to and how best to use them.
- [Workspace Filters](https://docs.peakmetrics.com/help/get-started-with-peakmetrics/finding-the-most-important-content-with-filters.md): Workspace search results can include an exceptionally large number of mentions if no specific criteria are added to the query. This may lead to results that are irrelevant or unwanted.
- [Workspaces](https://docs.peakmetrics.com/help/get-started-with-peakmetrics/getting-started-with-workspaces.md): This article will help you use PeakMetrics' Workspaces to monitor your brand, organization, competitors, campaigns, or industry topics.
- [AI-Generated Summaries](https://docs.peakmetrics.com/help/get-started-with-peakmetrics/harnessing-peakmetrics-dynamic-ai-generated-summaries.md): AI-generated summaries provide instant insights about your workspace or mentions tailored to your needs. We built this feature to hyper-enable our users and speed up your workflows.
- [Identifying Automation and Coordinated Behavior with PeakMetrics Bot Detection](https://docs.peakmetrics.com/help/get-started-with-peakmetrics/peakmetrics-bot-detection.md): PeakMetrics Bot Detection helps you identify and segment likely automated or coordinated accounts within your social media mentions. Read below to learn more about how bot detection works and how to leverage it to gain deeper insights.
- [Workspace Templates](https://docs.peakmetrics.com/help/get-started-with-peakmetrics/workspace-templates.md): Spin up a new workspace from a preset template.
- [Threat Scores](https://docs.peakmetrics.com/help/narratives/comprehensive-guide-to-threat-scores.md): This document is a guide to Threat Scores, PeakMetrics's narrative prioritization framework.
- [Narrative Layers](https://docs.peakmetrics.com/help/narratives/understanding-narrative-layers.md): Narrative layers provide multiple levels of granularity within narratives, making it easier to analyze and interpret the information in your workspace. This feature offers both a big-picture view and the ability to drill down into specific details.
- [Historic Mentions](https://docs.peakmetrics.com/help/peakmetrics-faqs/fill-your-workspace-with-historic-mentions.md): We know that looking at historic mentions can be vital for your analysis.
- [Narrative Best Practices](https://docs.peakmetrics.com/help/peakmetrics-faqs/how-to-build-great-narratives.md): This article serves as a comprehensive guide to effectively generate strong Narratives within PeakMetrics.
- [Narrative Intelligence Glossary](https://docs.peakmetrics.com/help/peakmetrics-faqs/narrative-intelligence-glossary.md): Welcome to PeakMetrics' narrative intelligence glossary. Here, you will find definitions for commonly used phrases and features within the PeakMetrics product ecosystem.
- [Notifications](https://docs.peakmetrics.com/help/peakmetrics-faqs/notifications-in-peakmetrics.md): Notifications in PeakMetrics are designed to keep you informed—simply, effectively, and on your terms. With just a few steps, you'll receive updates straight to your inbox, tailored to the cadence and types of alerts that matter most to your team.
- [PeakMetrics Data Sources](https://docs.peakmetrics.com/help/peakmetrics-faqs/peakmetrics-data-sources.md): At PeakMetrics, we strive to provide the best coverage possible across all sources. However, no system can capture everything. If you notice a missed mention, please flag it to our team—we're always working to improve!
- [Data Lake](https://docs.peakmetrics.com/help/peakmetrics-faqs/understanding-the-peakmetrics-data-lake.md): Understanding the PeakMetrics Data Lake
- [What is a Narrative?](https://docs.peakmetrics.com/help/peakmetrics-faqs/what-is-a-narrative-and-how-does-it-work.md): PeakMetrics uses AI to sort through billions of interactions and help you understand the trends, stories, and communities driving what we call Narratives.
- [What is Managed Attribution?](https://docs.peakmetrics.com/help/peakmetrics-faqs/what-is-managed-attribution-and-how-does-it-work.md): This guide explains what Managed Attribution is, why it matters, how you can enable it, and its limitations. Managed Attribution ensures your online activities remain private and secure while using PeakMetrics.
- [Author and Image Smart Categories](https://docs.peakmetrics.com/help/workflows/author-and-image-smart-categories.md): Extend Smart Categories beyond text to classify mentions based on visual content and author-level signals.
- [Custom Summaries](https://docs.peakmetrics.com/help/workflows/custom-summaries.md): Tailor your AI-generated summaries to fit your specific needs.
- [Topic Conversations](https://docs.peakmetrics.com/help/workflows/decipher-conversations-on-a-topic.md): This article dives into expert tips & tricks on how to best analyze the conversations within a workspace.
- [Regulation Detection](https://docs.peakmetrics.com/help/workflows/detect-regulation-discussions-around-a-topic.md): This article Leverages Twitter Lists to showcase how Regulators are communicating around specific topics.
- [Exporting Data](https://docs.peakmetrics.com/help/workflows/exporting-data-from-peakmetrics-unlocking-powerful-insights.md): Exporting data from PeakMetrics allows you to perform in-depth analysis outside of the platform.
- [Network Graphs](https://docs.peakmetrics.com/help/workflows/network-graphs-visualize-the-web-of-influence.md): Explore how narratives spread and which actors are behind them with interactive, real-time visualizations.
- [Smart Cats Workflow](https://docs.peakmetrics.com/help/workflows/smart-categories-workflow-guide.md): Smart Categories allow you to automatically classify mentions based on custom prompts. Below are four advanced prompt examples tailored to common use cases. These can be deployed directly or adapted to suit your organization's unique goals.
- [Changelog](https://docs.peakmetrics.com/mcp/changelog.md)
- [FAQ](https://docs.peakmetrics.com/mcp/faq.md): Frequently asked questions for how to get the most out of the PeakMetrics MCP server
- [Getting Started](https://docs.peakmetrics.com/mcp/getting-started.md): Connect PeakMetrics to ChatGPT or Claude in minutes
- [Introduction](https://docs.peakmetrics.com/mcp/introduction.md): Connect PeakMetrics to ChatGPT or Claude to access narrative intelligence directly in your AI assistant
- [Tools](https://docs.peakmetrics.com/mcp/tools.md): The PeakMetrics MCP server provides the following tools for accessing your narrative intelligence data.

## OpenAPI Specs

- [api_docs](https://docs.peakmetrics.com/api/api_docs.yaml)

## Optional

- [Insights](https://www.peakmetrics.com/insights)