> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peakmetrics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> PeakMetrics API v2.0 - Access media intelligence data programmatically

## Welcome to the PeakMetrics API

The PeakMetrics API provides programmatic access to media intelligence data, including workspaces, mentions, and narratives across multiple channels.

**Base URL:** `https://api.peakmetrics.com`

**API Version:** 2.0.0

## Core Concepts

### Workspaces

A **Workspace** defines a segment of the media ecosystem you're interested in analyzing and is comprised of all related mentions. Typical workspaces represent:

* A company (e.g., "Home Depot")
* A key executive
* An industry or topic (e.g., "Artificial Intelligence")
* A group of sources or geographic region

### Mentions

A **Mention** is a piece of content written by an author, promoted by a publisher, and released on a domain as part of a channel. Mentions are the fundamental data units in PeakMetrics.

### Narratives

**Narratives** are AI-generated groupings of related mentions that share a common theme or topic. Each narrative includes:

* AI-generated title and summary
* Mention count and sentiment analysis
* Relevancy scoring
* User-assigned tags

### Channels

PeakMetrics monitors content across multiple channels:

* News
* Social media (Twitter, Facebook, Instagram, Threads, Bluesky)
* Video platforms (YouTube, TikTok)
* Discussion platforms (Reddit, Telegram)
* International platforms (VK, Weibo)
* Blogs and discussions

## Authentication

All API endpoints (except `/access/token`) require authentication using Bearer tokens with JWT format.

### Getting an Access Token

First, obtain an access token using your credentials:

```bash theme={null}
POST /access/token
```

```json theme={null}
{
  "username": "your_username",
  "password": "your_password",
  "client_id": "your_client_id"
}
```

The response includes:

```json theme={null}
{
  "Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "ExpiresIn": 3600
}
```

### Using the Token

Include the token in the Authorization header for all subsequent requests:

```bash theme={null}
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
```

## Rate Limits & Pagination

* **Workspaces:** No explicit limit
* **Narratives:** Maximum 1000 per request (use `limit` and `offset` for pagination)
* **Mentions:** Maximum 50 per request (use `limit` and `offset` for pagination)

## Quick Start

1. Authenticate and get an access token `POST /access/token`
2. Retrieve your workspaces `GET /workspaces`
3. For a workspace, get its available filters `GET /workspace/{workspaceId}/available-filters`
4. Query analytics, mentions, or narratives with filters applied