Skip to main content

Mentions API

Base URL​

/api

All endpoints require authentication using Authorization: Bearer <token>.

Endpoints​

GET /mentions​

Retrieve a list of all mentions/targeted account contents.

Headers:

  • Authorization: Bearer <token>

Query Parameters:

  • project_id (optional): Filter by project ID
  • keyword (optional): Filter by keyword
  • date_from (optional): Start date filter (YYYY-MM-DD)
  • date_to (optional): End date filter (YYYY-MM-DD)
  • limit (optional): Items per page (default: 20)
  • offset (optional): Pagination offset (default: 0)

Response:

{
  "mentions": [
    {
      "id": "string",
      "account_name": "string",
      "account_username": "string",
      "content": "string",
      "platform": "string",
      "url": "string",
      "posted_at": "datetime",
      "engagement": {
        "likes": 0,
        "comments": 0,
        "shares": 0
      },
      "sentiment": "positive|negative|neutral",
      "project_id": "string",
      "keyword": "string"
    }
  ],
  "pagination": {
    "total": 150,
    "limit": 20,
    "offset": 0,
    "has_next": true
  }
}

Error Responses​

401 Unauthorized​

{
  "error": "Invalid or missing token"
}

403 Forbidden​

{
  "error": "Access denied"
}

500 Internal Server Error​

{
  "error": "Internal server error"
}

Response Fields Explanation​

Mention object​

  • id: Unique identifier for the mention
  • account_name: Name of the account that posted the mention
  • account_username: Account username/handle
  • content: Text content of the mention
  • platform: Social media platform (twitter, instagram, etc.)
  • url: URL to the original content
  • posted_at: Time the content was posted
  • engagement: Engagement statistics (likes, comments, shares)
  • sentiment: Sentiment analysis result for the content
  • project_id: Related project ID
  • keyword: Keyword that triggered the mention

Pagination object​

  • total: Total number of items
  • limit: Number of items per page
  • offset: Starting position of the data
  • has_next: Whether there is a next page