Skip to content
UltimateTeam.ai Docs

Get weekly social summary

GET
/api/social-analytics/weekly-summary
curl --request GET \
  --url https://api.ultimateteam.ai/api/social-analytics/weekly-summary \
  --header 'X-API-Key: <X-API-Key>'

Weekly social media performance summary for the CEO morning brief.

Authorizations

Section titled “Authorizations”

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
WeeklySocialSummary

Weekly social media performance summary for the CMO/CEO morning brief.

Attributes: period: Human-readable period description. highlights: Key performance highlights. metrics: Full unified metrics for the week. top_posts: Top performing posts with engagement data. recommendations: Actionable improvement recommendations.

object
highlights
Highlights
Array<string>
metrics
UnifiedSocialMetrics

Aggregated social media metrics across all connected platforms.

Attributes: total_reach: Combined reach across all platforms. total_impressions: Combined impressions across all platforms. total_engagement: Combined engagement actions across all platforms. overall_engagement_rate: total_engagement / total_impressions. follower_growth: Net follower change across platforms. platforms: Per-platform metric breakdown. period_start: Start of the measured period. period_end: End of the measured period.

object
follower_growth
Follower Growth
integer
0
overall_engagement_rate
Overall Engagement Rate
number
0
period_end
Period End
string format: date
period_start
Period Start
string format: date
platforms
Platforms
object
key
additional properties
PlatformMetrics

Per-platform aggregated engagement metrics for a date range.

Attributes: platform: Social platform identifier. reach: Total unique users who saw content. impressions: Total content views (including repeats). engagement: Total engagement actions (likes + shares + comments + clicks). likes: Total likes/reactions. shares: Total shares/retweets/reposts. comments: Total comments/replies. clicks: Total link clicks. followers: Current follower count (latest known). engagement_rate: engagement / impressions (0.0 if no impressions). period_start: Start of the measured period. period_end: End of the measured period.

object
clicks
Clicks
integer
0
comments
Comments
integer
0
engagement
Engagement
integer
0
engagement_rate
Engagement Rate
number
0
followers
Followers
integer
0
impressions
Impressions
integer
0
likes
Likes
integer
0
period_end
Period End
string format: date
period_start
Period Start
string format: date
platform
required
Platform
string
reach
Reach
integer
0
shares
Shares
integer
0
total_engagement
Total Engagement
integer
0
total_impressions
Total Impressions
integer
0
total_reach
Total Reach
integer
0
period
Period
string
""
recommendations
Recommendations
Array<string>
top_posts
Top Posts
Array<object>
object
key
additional properties
any
Example
{
  "metrics": {
    "follower_growth": 0,
    "overall_engagement_rate": 0,
    "platforms": {
      "additionalProperty": {
        "clicks": 0,
        "comments": 0,
        "engagement": 0,
        "engagement_rate": 0,
        "followers": 0,
        "impressions": 0,
        "likes": 0,
        "reach": 0,
        "shares": 0
      }
    },
    "total_engagement": 0,
    "total_impressions": 0,
    "total_reach": 0
  },
  "period": ""
}