Skip to main content
Retrieve all interactions (likes and comments) for posts in a specific watchlist. Use this endpoint to analyze engagement activity, build custom reports, or power internal dashboards.

​
Query Parameters

​
watchlist_id
string
required
Watchlist ID to retrieve interactions from. This parameter is required and must be a single watchlist ID.
​
interaction_type
string
Filter by interaction type. Options:
  • like
  • comment
​
actor_ids
string | array
Optional filter for specific actors involved in the interaction. This can include:
  • OutX user IDs (for users who liked/commented)
  • Author IDs
  • Company IDs
Accepts:
  • A single ID string
  • Multiple values as a comma-separated string
  • Multiple values as repeated query params (e.g., actor_ids=id1&actor_ids=id2)
​
page
number
default:"1"
Page number for pagination (1-indexed).
​
page_size
number
default:"10"
Number of interactions per page. Maximum: 100.
curl -X GET \
  "https://api.outx.ai/api-interactions?watchlist_id=550e8400-e29b-41d4-a716-446655440000&page=1&page_size=10" \
  -H "x-api-key: YOUR_API_KEY"

{
  "data": [
    {
      "id": "interaction-123",
      "text": "Great insights, thanks for sharing!",
      "interaction_type": "comment",
      "created_at": 1705401600000,
      "author": {
        "id": "author-1",
        "full_name": "Jane Doe",
        "author_slug": "janedoe",
        "headline": "VP of Marketing",
        "author_type": "user"
      },
      "post": {
        "id": "post-123",
        "linkedin_post_url": "https://linkedin.com/feed/update/urn:li:activity:1234567890",
        "content": "Excited to announce our new feature...",
        "created_at": 1705400000000,
        "likes_count": 120,
        "shares_count": 10,
        "comments_count": 24,
        "bookmark": false,
        "post_type": "image",
        "linkedin_post_urn": "urn:li:activity:1234567890",
        "language": "en",
        "tags": ["product-launch", "saas"],
        "videos": null,
        "social_urn": "urn:li:activity:1234567890",
        "primary_keywords": ["AI", "automation"],
        "tracking_lists_slug": "enterprise-ai-watchlist",
        "list_info": [],
        "post_author": {
          "id": "author-1",
          "full_name": "Jane Doe",
          "author_slug": "janedoe",
          "headline": "VP of Marketing",
          "author_image_url": "https://media.licdn.com/dms/image/..."
        }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 10,
    "total": 42,
    "total_pages": 5,
    "total_likes": 30,
    "total_comments": 12
  },
  "graph_data": [
    {
      "posted_at": "2024-01-10",
      "like_count": 5,
      "comment_count": 2
    }
  ]
}
​
data
array
Array of interaction objects, each containing interaction details and the associated post.
​
pagination
object
Pagination metadata including current page, page size, total interactions, and totals by interaction type.
​
graph_data
array
Time-series data for the last 7 days, aggregating like and comment counts per day.

​
Interaction Object Fields

​
id
string
Unique interaction identifier.
​
text
string
Text content of the interaction (for comments).
​
interaction_type
string
Type of interaction. One of: like, comment.
​
created_at
number
Interaction timestamp in milliseconds since epoch.
​
author
object
JSON object describing the interaction author (user or company).
​
post
object
Embedded post object with the same structure as the Posts API.

​
Error Responses

Status CodeError MessageDescription
400watchlist_id is required and must be a stringMissing or invalid watchlist_id parameter
400Invalid watchlist ID: <id>The provided watchlist_id does not exist
401Missing API Key / Invalid API KeyAPI key is missing or incorrect
403Access denied: You don’t have permission to access this watchlistThe watchlist belongs to a different team
500Failed to fetch interactionsInternal server error