> ## 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.

# Add mentions

> 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.

You may submit up to 100 mentions per request.

PeakMetrics secures custom channel data by segregating it from other channel data
while in processing and in storage.




## OpenAPI

````yaml /api/api_docs.yaml post /customChannels/{channelId}/mentions
openapi: 3.1.0
info:
  title: PeakMetrics API
  description: >
    The PeakMetrics API provides programmatic access to narrative intelligence
    data.


    Access millions of mentions across news, social media, and online platforms,
    enriched with custom AI-powered

    smart categories and over 50 metadata properties. The API enables you to

    identify, analyze, and act on emerging narratives in real-time.
  version: 2.0.0
servers:
  - url: https://api.peakmetrics.com
    description: Main (production) server
security:
  - BearerAuth: []
tags:
  - name: Authorization
  - name: Workspaces
  - name: Folders
  - name: Channels
  - name: Custom Channels
  - name: Custom Enrichments
    description: >
      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 through the customer API
      and the MCP

      server.


      Your team manages its own custom enrichments through the API: create one
      with

      `POST /customEnrichments`, list them with `GET /customEnrichments`, rename
      one or

      replace its option list with `PUT /customEnrichments/{enrichmentId}`,
      retire one with

      `DELETE /customEnrichments/{enrichmentId}`, and push values for individual
      mentions

      with `PUT /mentions/customEnrichments`.
paths:
  /customChannels/{channelId}/mentions:
    post:
      tags:
        - Custom Channels
      summary: Add mentions
      description: >
        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.


        You may submit up to 100 mentions per request.


        PeakMetrics secures custom channel data by segregating it from other
        channel data

        while in processing and in storage.
      parameters:
        - in: path
          name: channelId
          required: true
          schema:
            type: string
            format: uuid
          description: The unique identifier for the custom channel.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - mentions
              properties:
                mentions:
                  type: array
                  maxItems: 100
                  description: An array of mentions to be added to the custom channel.
                  items:
                    type: object
                    required:
                      - title
                      - text
                      - author
                      - published
                      - url
                    properties:
                      title:
                        type: string
                        description: The title of the mention
                      text:
                        type: string
                        description: The content text of the mention
                      author:
                        type: string
                        description: The author of the mention
                      published:
                        type: string
                        format: date-time
                        description: >-
                          The publish date and time of the mention. Must include
                          milliseconds in ISO 8601 format.
                        example: '2024-01-15T14:30:45.123Z'
                      url:
                        type: string
                        format: uri
                        description: The source URL of the mention
                      thumbnailUrl:
                        type: string
                        format: uri
                        description: Optional URL to a thumbnail image for the mention
      responses:
        '202':
          description: Mentions have been accepted for ingestion
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Mentions are queued up for ingestion
                  count:
                    type: integer
                    description: Number of mentions accepted for ingestion
        '400':
          description: One or more mentions failed validation
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
        '404':
          description: Custom channel not found or user does not have access
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
        '429':
          description: Rate limit or quota exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        example: >-
                          You have exceeded your minute rate limit of 1000,
                          which will reset at 2024-01-01T00:01:00Z
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````