Get platform summary
Returns one platform's normalized analytics availability, summary metrics, daily trend, connected-account health, and top posts from the unified UniPost Analytics API.
Authorization
AuthorizationBearer <token>In header
Workspace API key.
Path Params
platformstring
Analytics-capable platform key.
Valuesinstagram | threads | pinterest | tiktok | facebook
Query Params
fromOptionalstring
Start date as YYYY-MM-DD. Defaults to the last 30 days.
toOptionalstring
End date as YYYY-MM-DD. Inclusive by day.
profile_idOptionalstring
Limit platform detail to one UniPost profile.
Response Body
200
platformstring
Platform key requested in the path.
period.startstring
Start date included in the response.
period.endstring
End date included in the response.
availability.platformstring
Platform key for the availability row.
availability.supported_metricsarray
Normalized metrics that UniPost can return for this platform.
availability.healthstring
Current analytics state.
Valuesnot_connected | pending | ready | degraded | needs_reconnect
summary.postsnumber
Published post count in the period.
summary.impressionsnumber
Summed normalized impressions.
summary.video_viewsnumber
Summed normalized video views.
summary.engagement_ratenumber
Computed engagement rate for the period.
trend[]array
Daily metric buckets for the platform.
accounts[]array
Connected accounts with post counts and analytics health.
top_posts[]array
Top post-level analytics rows sorted by engagement rate.
401
error.codestring
Usually "UNAUTHORIZED", "PLAN_FEATURE_NOT_AVAILABLE", "NOT_FOUND", or "VALIDATION_ERROR".
error.normalized_codestring
Lowercase error code.
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
402
error.codestring
Usually "UNAUTHORIZED", "PLAN_FEATURE_NOT_AVAILABLE", "NOT_FOUND", or "VALIDATION_ERROR".
error.normalized_codestring
Lowercase error code.
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
404
error.codestring
Usually "UNAUTHORIZED", "PLAN_FEATURE_NOT_AVAILABLE", "NOT_FOUND", or "VALIDATION_ERROR".
error.normalized_codestring
Lowercase error code.
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
422
error.codestring
Usually "UNAUTHORIZED", "PLAN_FEATURE_NOT_AVAILABLE", "NOT_FOUND", or "VALIDATION_ERROR".
error.normalized_codestring
Lowercase error code.
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.