Skip to main content
GET
/
workspaces
/
{workspaceId}
/
mentions
Get mentions within the provided workspace ID.
curl --request GET \
  --url https://api.peakmetrics.com/workspaces/{workspaceId}/mentions \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1234,
    "title": "<string>",
    "text": "<string>",
    "url": "<string>",
    "domain": "<string>",
    "author": "<string>",
    "channels": [
      "blogsdiscussions"
    ],
    "media": [
      {
        "type": "image",
        "url": "<string>"
      }
    ],
    "language": "<string>",
    "enrichments": {
      "narratives": [
        {
          "id": 123,
          "confidence": 50
        }
      ],
      "sentiment": {
        "polarity": 0,
        "version": 1
      }
    },
    "publisherGeography": {
      "sourceCountry": "United States",
      "sourceRegion": "Americas",
      "sourceSubRegion": "Northern America"
    },
    "created": "2023-11-07T05:31:56Z",
    "processed": "2023-11-07T05:31:56Z",
    "published": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workspaceId
integer
required

The unique identifier for the workspace.

Required range: x >= 1

Query Parameters

​
limit
integer

The maximum number of mentions to return, default 10. To get more mentions, use in combination with the offset parameter to paginate.

Required range: 1 <= x <= 50
​
offset
integer

The number of mentions to skip before returning, default 0. Use in combination with the limit parameter to paginate.

Required range: x >= 0
​
sort
enum<string>

The field to sort the mentions by descending, default published.

Available options:
created,
published,
confidence
​
order
enum<string>

The order to sort the mentions by, default desc.

Available options:
asc,
desc
​
since
string<date-time>
required

The minimum published date of the mentions to return.

​
to
string<date-time>
required

The maximum published date of the mentions to return.

​
narratives.id
number[]

Filter the returned mentions to those that are part of the provided narrative IDs.

​
channels
enum<string>[]

Filter the returned mentions to those that are part of the provided channel.

Available options:
blogsdiscussions,
bluesky,
facebook,
instagram,
news,
reddit,
redditComment,
telegram,
threads,
tiktok,
twitter,
vk,
weibo,
youtube
​
filter_expression
string

Filter the returned mentions to those that match the filtered expression.

Response

A JSON array of mention objects

​
id
integer

The unique identifier for the narrative.

Example:

1234

​
title
string

The title for the mention, if available.

​
text
string

The text for the mention, if available.

​
url
string

The original URL to the mention.

​
domain
string

The domain of the mention URL—a distinct subset of the internet with URL addresses sharing a common suffix or under the control of a particular organization or individual.

Domain Types:

  • News organizations publishing content through their website
  • Social networks and messaging platforms
  • Blogs and independent publishers
  • Video and media platforms

Note: Common sub-domains such as www are normalized and removed.

Examples: nytimes.com, twitter.com, telegram.org, reddit.com

​
author
string

The author of the mention—an individual who writes a piece of digital content, indicated by the byline or social account attached to the content.

Author Types:

  • Journalists and reporters
  • Social media accounts and influencers
  • Blog writers and content creators
  • Public figures and verified accounts

Understanding author attribution helps identify the voices driving narratives and assess source credibility.

​
channels
enum<string>[]

A Channel represents a specific type of platform where content is released and consumed. PeakMetrics monitors millions of sources across traditional and emerging channels to provide comprehensive narrative intelligence.

Available Channels:

  • News: Traditional news outlets and online publications
  • Social Media: Twitter, Facebook, Instagram, Threads, Bluesky
  • Video Platforms: YouTube, TikTok
  • Discussion Forums: Reddit, Reddit Comments, Telegram
  • International Platforms: VK (Russian), Weibo (Chinese)
  • Blogs & Discussions: General blogs and discussion platforms

Multi-channel monitoring helps identify how narratives spread across different platforms and audiences, enabling comprehensive media intelligence analysis.

Available options:
blogsdiscussions,
bluesky,
facebook,
instagram,
news,
reddit,
redditComment,
telegram,
threads,
tiktok,
twitter,
vk,
weibo,
youtube
​
media
object[]
​
language
string

The language of the mention, represented as a two-letter ISO 639-1 code.

Common Language Codes:

  • en - English
  • es - Spanish
  • fr - French
  • de - German
  • zh - Chinese
  • ru - Russian

Note: Language is detected automatically using machine learning and may not be 100% accurate. PeakMetrics supports multilingual sentiment analysis to detect narratives across global markets and regional trends.

​
enrichments
object

The enrichments of the mention.

​
publisherGeography
object

(News only) The location of the news publisher, as provided by LexisNexis (not supported for all news sites).

​
created
string<date-time>

The date and time the mention was created.

​
processed
string<date-time>

The date and time the mention was last updated by data processor.

​
published
string<date-time>

The date and time the mention was published.