Add enrichments

curl --request PUT \
  --url https://api.peakmetrics.com/mentions/customEnrichments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "url": "https://example.com/news/article-123",
    "enrichment_id": 1681,
    "value": "Substantiated"
  },
  {
    "url": "https://example.com/news/article-456",
    "enrichment_id": 1681,
    "value": "Mixed"
  }
]
'

{
  "message": "Enrichments are queued up for processing",
  "count": 2
}

Custom Enrichments

Add enrichments

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.

The request body is an array of up to 100 enrichment updates. The request is processed atomically — if any update fails validation, the entire request is rejected with a 400 response and no values are written.

Updates are applied asynchronously after the request is accepted. Newly pushed values typically appear on the mention within a few minutes across the GET APIs, the MCP server, mention exports, and the workspace UI.

Rate limits

Two rolling limits apply, scoped to the authenticated team:

50 requests per minute (rolling 60-second window)
5,000 requests per day (resets at midnight UTC)

When either limit is exceeded, the endpoint returns a 429 response indicating which limit was hit and when it resets.

Storage and visibility

Enrichment values are stored on the underlying mention document, not scoped to a workspace. A single value pushed for a mention is visible from every workspace whose query matches that mention, as well as the MCP server, mention exports, and the customEnrichments field returned by the GET APIs.

PUT

/

mentions

/

customEnrichments

Add enrichments

curl --request PUT \
  --url https://api.peakmetrics.com/mentions/customEnrichments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "url": "https://example.com/news/article-123",
    "enrichment_id": 1681,
    "value": "Substantiated"
  },
  {
    "url": "https://example.com/news/article-456",
    "enrichment_id": 1681,
    "value": "Mixed"
  }
]
'

{
  "message": "Enrichments are queued up for processing",
  "count": 2
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Maximum array length: 100

url

string<uri>

required

The URL of the mention to enrich. The mention must already exist in PeakMetrics. Both standard and custom channel mentions are supported.

Example:

"https://example.com/news/article-123"

enrichment_id

integer

required

The identifier of the custom enrichment, as returned by GET /customEnrichments. The custom enrichment must be accessible to the authenticated team.

Example:

1681

value

string

required

The value to write for this enrichment on this mention. Any string is accepted; values outside the custom enrichment's current constraints.enum are recorded and will appear in future GET /customEnrichments responses as new categories.

Example:

"Substantiated"

Response

All updates passed validation and have been queued for processing.

message

string

Example:

"Enrichments are queued up for processing"

count

integer

The number of enrichment updates accepted.

Example:

2

Custom enrichments

⌘I