This tool is part of the Engagement Tools category.

​
Parameters

NameTypeRequiredDescription
user_account_idstringYesThe ID of the user account to get engagement for

​
Example Request

{
  "user_account_id": "ua_123456"
}

​
Example Response

{
  "id": "eng_789012",
  "account_id": "acc_345678",
  "day": "2023-06-15",
  "view": "45231",
  "comment": "512",
  "like": "3892",
  "share": "237",
  "subscriber_gain": "89",
  "subscriber_loss": "12",
  "reach": "67439",
  "engagement": "4641",
  "profile_activity": "821",
  "profile_visit": "1238",
  "save": "347",
  "total_watchtime_in_hour": 923.5,
  "average_watchtime_in_seconds": 74.2,
  "created_at": "2023-06-16T00:05:23.000Z",
  "updated_at": "2023-06-16T00:05:23.000Z"
}

​
Metric Definitions

MetricDescription
viewTotal number of content views for the account
commentTotal number of comments received on account content
likeTotal number of likes received on account content
shareTotal number of times account content has been shared
subscriber_gainNumber of new followers/subscribers gained
subscriber_lossNumber of followers/subscribers lost
reachNumber of unique accounts that have seen the account’s content
engagementTotal engagement actions (likes + comments + shares + saves)
profile_activityActions taken on the account profile page
profile_visitNumber of visits to the account profile
saveNumber of times account content has been saved/bookmarked
total_watchtime_in_hourTotal hours of watch time for video content (where applicable)
average_watchtime_in_secondsAverage watch time per video view in seconds (where applicable)

​
Usage Notes

  • Engagement metrics may vary by platform, and not all metrics will be available for all platforms.
  • For YouTube and LinkedIn accounts, metrics are accumulated over time, showing lifetime totals.
  • For other platforms like Instagram, metrics show the specific values for the date.
  • Historical data may be available by checking multiple day records.
  • Metrics like subscriber_gain and subscriber_loss are daily values, not cumulative totals.
  • Bigint values are returned as strings to preserve precision.