Skip to content

Latest commit

 

History

History
457 lines (271 loc) · 21.4 KB

File metadata and controls

457 lines (271 loc) · 21.4 KB

\AnalyticsApi

All URIs are relative to https://zernio.com/api

Method HTTP request Description
get_analytics GET /v1/analytics Get post analytics
get_best_time_to_post GET /v1/analytics/best-time Get best times to post
get_content_decay GET /v1/analytics/content-decay Get content performance decay
get_daily_metrics GET /v1/analytics/daily-metrics Get daily aggregated metrics
get_follower_stats GET /v1/accounts/follower-stats Get follower stats
get_instagram_account_insights GET /v1/analytics/instagram/account-insights Get Instagram account-level insights
get_instagram_demographics GET /v1/analytics/instagram/demographics Get Instagram audience demographics
get_linked_in_aggregate_analytics GET /v1/accounts/{accountId}/linkedin-aggregate-analytics Get LinkedIn aggregate stats
get_linked_in_post_analytics GET /v1/accounts/{accountId}/linkedin-post-analytics Get LinkedIn post stats
get_linked_in_post_reactions GET /v1/accounts/{accountId}/linkedin-post-reactions Get LinkedIn post reactions
get_post_timeline GET /v1/analytics/post-timeline Get post analytics timeline
get_posting_frequency GET /v1/analytics/posting-frequency Get posting frequency vs engagement
get_you_tube_daily_views GET /v1/analytics/youtube/daily-views Get YouTube daily views

get_analytics

models::GetAnalytics200Response get_analytics(post_id, platform, profile_id, account_id, source, from_date, to_date, limit, page, sort_by, order) Get post analytics

Returns analytics for posts. With postId, returns a single post. Without it, returns a paginated list with overview stats. Accepts both Zernio Post IDs and External Post IDs (auto-resolved). fromDate defaults to 90 days ago if omitted, max range 366 days. Single post lookups may return 202 (sync pending) or 424 (all platforms failed). For follower stats, use /v1/accounts/follower-stats.

Parameters

Name Type Description Required Notes
post_id Option<String> Returns analytics for a single post. Accepts both Zernio Post IDs and External Post IDs. Zernio IDs are auto-resolved to External Post analytics.
platform Option<String> Filter by platform (default "all")
profile_id Option<String> Filter by profile ID (default "all")
account_id Option<String> Filter by social account ID
source Option<String> Filter by post source: late (posted via Zernio API), external (synced from platform), all (default) [default to all]
from_date Option<String> Inclusive lower bound (YYYY-MM-DD). Defaults to 90 days ago if omitted. Max range is 366 days.
to_date Option<String> Inclusive upper bound (YYYY-MM-DD). Defaults to today if omitted.
limit Option<i32> Page size (default 50) [default to 50]
page Option<i32> Page number (default 1) [default to 1]
sort_by Option<String> Sort by date, engagement, or a specific metric [default to date]
order Option<String> Sort order [default to desc]

Return type

models::GetAnalytics200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_best_time_to_post

models::GetBestTimeToPost200Response get_best_time_to_post(platform, profile_id, source) Get best times to post

Returns the best times to post based on historical engagement data. Groups all published posts by day of week and hour (UTC), calculating average engagement per slot. Use this to auto-schedule posts at optimal times. Requires the Analytics add-on.

Parameters

Name Type Description Required Notes
platform Option<String> Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
profile_id Option<String> Filter by profile ID. Omit for all profiles.
source Option<String> Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. [default to all]

Return type

models::GetBestTimeToPost200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_content_decay

models::GetContentDecay200Response get_content_decay(platform, profile_id, source) Get content performance decay

Returns how engagement accumulates over time after a post is published. Each bucket shows what percentage of the post's total engagement had been reached by that time window. Useful for understanding content lifespan (e.g. "posts reach 78% of total engagement within 24 hours"). Requires the Analytics add-on.

Parameters

Name Type Description Required Notes
platform Option<String> Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
profile_id Option<String> Filter by profile ID. Omit for all profiles.
source Option<String> Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. [default to all]

Return type

models::GetContentDecay200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_daily_metrics

models::GetDailyMetrics200Response get_daily_metrics(platform, profile_id, account_id, from_date, to_date, source) Get daily aggregated metrics

Returns daily aggregated analytics metrics and a per-platform breakdown. Each day includes post count, platform distribution, and summed metrics (impressions, reach, likes, comments, shares, saves, clicks, views). Defaults to the last 180 days. Requires the Analytics add-on.

Parameters

Name Type Description Required Notes
platform Option<String> Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
profile_id Option<String> Filter by profile ID. Omit for all profiles.
account_id Option<String> Filter by social account ID
from_date Option<String> Inclusive start date (ISO 8601). Defaults to 180 days ago.
to_date Option<String> Inclusive end date (ISO 8601). Defaults to now.
source Option<String> Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. [default to all]

Return type

models::GetDailyMetrics200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_follower_stats

models::GetFollowerStats200Response get_follower_stats(account_ids, profile_id, from_date, to_date, granularity) Get follower stats

Returns follower count history and growth metrics for connected social accounts. Requires analytics add-on subscription. Follower counts are refreshed once per day.

Parameters

Name Type Description Required Notes
account_ids Option<String> Comma-separated list of account IDs (optional, defaults to all user's accounts)
profile_id Option<String> Filter by profile ID
from_date Option<String> Start date in YYYY-MM-DD format (defaults to 30 days ago)
to_date Option<String> End date in YYYY-MM-DD format (defaults to today)
granularity Option<String> Data aggregation level [default to daily]

Return type

models::GetFollowerStats200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_instagram_account_insights

models::InstagramAccountInsightsResponse get_instagram_account_insights(account_id, metrics, since, until, metric_type, breakdown) Get Instagram account-level insights

Returns account-level Instagram insights such as reach, views, accounts engaged, and total interactions. These metrics reflect the entire account's performance across all content surfaces (feed, stories, explore, profile), and are fundamentally different from post-level metrics. Data may be delayed up to 48 hours. Max 90 days, defaults to last 30 days. Requires the Analytics add-on.

Parameters

Name Type Description Required Notes
account_id String The Zernio SocialAccount ID for the Instagram account [required]
metrics Option<String> Comma-separated list of metrics. Defaults to "reach,views,accounts_engaged,total_interactions". Valid metrics: reach, views, accounts_engaged, total_interactions, comments, likes, saves, shares, replies, reposts, follows_and_unfollows, profile_links_taps. Note: only "reach" supports metricType=time_series. All other metrics are total_value only.
since Option<String> Start date (YYYY-MM-DD). Defaults to 30 days ago.
until Option<String> End date (YYYY-MM-DD). Defaults to today.
metric_type Option<String> "total_value" (default) returns aggregated totals and supports breakdowns. "time_series" returns daily values but only works with the "reach" metric. [default to total_value]
breakdown Option<String> Breakdown dimension (only valid with metricType=total_value). Valid values depend on the metric: media_product_type, follow_type, follower_type, contact_button_type.

Return type

models::InstagramAccountInsightsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_instagram_demographics

models::InstagramDemographicsResponse get_instagram_demographics(account_id, metric, breakdown, timeframe) Get Instagram audience demographics

Returns audience demographic insights for an Instagram account, broken down by age, city, country, and/or gender. Requires at least 100 followers. Returns top 45 entries per dimension. Data may be delayed up to 48 hours. Requires the Analytics add-on.

Parameters

Name Type Description Required Notes
account_id String The Zernio SocialAccount ID for the Instagram account [required]
metric Option<String> "follower_demographics" for follower audience data, or "engaged_audience_demographics" for engaged viewers. [default to follower_demographics]
breakdown Option<String> Comma-separated list of demographic dimensions: age, city, country, gender. Defaults to all four if omitted.
timeframe Option<String> Time period for demographic data. Defaults to "this_month". [default to this_month]

Return type

models::InstagramDemographicsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_linked_in_aggregate_analytics

models::GetLinkedInAggregateAnalytics200Response get_linked_in_aggregate_analytics(account_id, aggregation, start_date, end_date, metrics) Get LinkedIn aggregate stats

Returns aggregate analytics across all posts for a LinkedIn personal account. Org accounts should use /v1/analytics instead. Requires r_member_postAnalytics scope.

Parameters

Name Type Description Required Notes
account_id String The ID of the LinkedIn personal account [required]
aggregation Option<String> TOTAL (default, lifetime totals) or DAILY (time series). MEMBERS_REACHED not available with DAILY. [default to TOTAL]
start_date Option<String> Start date (YYYY-MM-DD). If omitted, returns lifetime analytics.
end_date Option<String> End date (YYYY-MM-DD, exclusive). Defaults to today if omitted.
metrics Option<String> Comma-separated metrics: IMPRESSION, MEMBERS_REACHED, REACTION, COMMENT, RESHARE. Omit for all.

Return type

models::GetLinkedInAggregateAnalytics200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_linked_in_post_analytics

models::GetLinkedInPostAnalytics200Response get_linked_in_post_analytics(account_id, urn) Get LinkedIn post stats

Returns analytics for a specific LinkedIn post by URN. Works for both personal and organization accounts.

Parameters

Name Type Description Required Notes
account_id String The ID of the LinkedIn account [required]
urn String The LinkedIn post URN [required]

Return type

models::GetLinkedInPostAnalytics200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_linked_in_post_reactions

models::GetLinkedInPostReactions200Response get_linked_in_post_reactions(account_id, urn, limit, cursor) Get LinkedIn post reactions

Returns individual reactions for a specific LinkedIn post, including reactor profiles (name, headline/job title, profile picture, profile URL, reaction type). Only works for organization/company page accounts. LinkedIn restricts reaction data for personal profiles (r_member_social_feed is a closed permission).

Parameters

Name Type Description Required Notes
account_id String The ID of the LinkedIn organization account [required]
urn String The LinkedIn post URN [required]
limit Option<i32> Maximum number of reactions to return per page [default to 25]
cursor Option<String> Offset-based pagination start index

Return type

models::GetLinkedInPostReactions200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_post_timeline

models::GetPostTimeline200Response get_post_timeline(post_id, from_date, to_date) Get post analytics timeline

Returns a daily timeline of analytics metrics for a specific post, showing how impressions, likes, and other metrics evolved day-by-day since publishing. Each row represents one day of data per platform. For multi-platform Zernio posts, returns separate rows for each platform. Requires the Analytics add-on.

Parameters

Name Type Description Required Notes
post_id String The post to fetch timeline for. Accepts an ExternalPost ID, a platformPostId, or a Zernio Post ID. [required]
from_date Option<String> Start of date range (ISO 8601). Defaults to 90 days ago.
to_date Option<String> End of date range (ISO 8601). Defaults to now.

Return type

models::GetPostTimeline200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_posting_frequency

models::GetPostingFrequency200Response get_posting_frequency(platform, profile_id, source) Get posting frequency vs engagement

Returns the correlation between posting frequency (posts per week) and engagement rate, broken down by platform. Helps find the optimal posting cadence for each platform. Each row represents a specific (platform, posts_per_week) combination with the average engagement rate observed across all weeks matching that frequency. Requires the Analytics add-on.

Parameters

Name Type Description Required Notes
platform Option<String> Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
profile_id Option<String> Filter by profile ID. Omit for all profiles.
source Option<String> Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. [default to all]

Return type

models::GetPostingFrequency200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_you_tube_daily_views

models::YouTubeDailyViewsResponse get_you_tube_daily_views(video_id, account_id, start_date, end_date) Get YouTube daily views

Returns daily view counts for a YouTube video including views, watch time, and subscriber changes. Requires yt-analytics.readonly scope (re-authorization may be needed). Data has a 2-3 day delay. Max 90 days, defaults to last 30 days.

Parameters

Name Type Description Required Notes
video_id String The YouTube video ID (e.g., "dQw4w9WgXcQ") [required]
account_id String The Zernio account ID for the YouTube account [required]
start_date Option<String> Start date (YYYY-MM-DD). Defaults to 30 days ago.
end_date Option<String> End date (YYYY-MM-DD). Defaults to 3 days ago (YouTube data latency).

Return type

models::YouTubeDailyViewsResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]