Skip to main content

Mention

Represents a single mention from social media, news, blogs, or other sources.
id
string
required
Unique identifier for the mention
title
string
Title or headline of the mention
description
string
Full description or content of the mention
description_short
string
Shortened description or excerpt
original_url
string
URL to the original source
source_name
string
Name of the source (e.g., “Twitter”, “New York Times”)
source_type
string
Type of source (e.g., “twitter”, “news”, “blog”)
tone
string
Sentiment/tone of the mention: positive, negative, or neutral
author
object
Author information
tags
array
default:"[]"
List of tags associated with the mention
favorite
boolean
default:"false"
Whether the mention is marked as favorite
read
boolean
default:"false"
Whether the mention has been read
trashed
boolean
default:"false"
Whether the mention is in the trash
published_at
string
ISO 8601 timestamp when the mention was published
reach
integer
Estimated reach of the mention
engagement
object
Engagement metrics (likes, shares, comments, etc.)
language
string
Language code of the mention (e.g., “en”)
country
string
Country code where the mention originated (e.g., “US”)
image_url
string
URL to an associated image
video_url
string
URL to an associated video
created_at
string
ISO 8601 timestamp when the mention was created in Mention
updated_at
string
ISO 8601 timestamp when the mention was last updated

Tone Enum

Sentiment values for mentions:
  • positive - Positive sentiment
  • negative - Negative sentiment
  • neutral - Neutral sentiment

Example

{
  "id": "mention_1234567890",
  "title": "Great product review",
  "description": "I've been using this product for a month and it's amazing!",
  "description_short": "Great product after a month of use",
  "original_url": "https://twitter.com/user/status/123456",
  "source_name": "Twitter",
  "source_type": "twitter",
  "tone": "positive",
  "author": {
    "id": "author_123",
    "name": "Jane Smith",
    "username": "janesmith",
    "profile_url": "https://twitter.com/janesmith",
    "avatar_url": "https://pbs.twimg.com/profile_images/123/avatar.jpg",
    "followers_count": 5420,
    "following_count": 890,
    "influence_score": 72.5
  },
  "tags": [
    {
      "id": "tag_1",
      "name": "Product Reviews",
      "color": "#3B82F6"
    }
  ],
  "favorite": false,
  "read": true,
  "trashed": false,
  "published_at": "2026-03-04T07:30:00Z",
  "reach": 5420,
  "engagement": {
    "likes": 42,
    "retweets": 8,
    "replies": 3
  },
  "language": "en",
  "country": "US",
  "image_url": "https://example.com/image.jpg",
  "video_url": null,
  "created_at": "2026-03-04T07:35:00Z",
  "updated_at": "2026-03-04T08:00:00Z"
}

Build docs developers (and LLMs) love