Class: Zernio::AnalyticsApi

#get_analytics(opts = {}) ⇒ `GetAnalytics200Response`

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. LinkedIn personal accounts: Analytics are only available for posts published through Zernio. LinkedIn's API only returns metrics for posts authored by the authenticated user. Organization/company page analytics work for all posts.

Parameters:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:post_id (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 (String) —
Filter by platform (default "all")
:profile_id (String) —
Filter by profile ID (default "all")
:account_id (String) —
Filter by social account ID
:source (String) —
Filter by post source: late (posted via Zernio API), external (synced from platform), all (default) (default to 'all')
:from_date (Date) —
Inclusive lower bound (YYYY-MM-DD). Defaults to 90 days ago if omitted. Max range is 366 days.
:to_date (Date) —
Inclusive upper bound (YYYY-MM-DD). Defaults to today if omitted.
:limit (Integer) —
Page size (default 50) (default to 50)
:page (Integer) —
Page number (default 1) (default to 1)
:sort_by (String) —
Sort by date, engagement, or a specific metric (default to 'date')
:order (String) —
Sort order (default to 'desc')

Returns:

(GetAnalytics200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 37

def get_analytics(opts = {})
  data, _status_code, _headers = get_analytics_with_http_info(opts)
  data
end

#get_analytics_with_http_info(opts = {}) ⇒ `Array<(GetAnalytics200Response, Integer, Hash)>`

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. LinkedIn personal accounts: Analytics are only available for posts published through Zernio. LinkedIn's API only returns metrics for posts authored by the authenticated user. Organization/company page analytics work for all posts.

Parameters:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:post_id (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 (String) —
Filter by platform (default "all")
:profile_id (String) —
Filter by profile ID (default "all")
:account_id (String) —
Filter by social account ID
:source (String) —
Filter by post source: late (posted via Zernio API), external (synced from platform), all (default) (default to 'all')
:from_date (Date) —
Inclusive lower bound (YYYY-MM-DD). Defaults to 90 days ago if omitted. Max range is 366 days.
:to_date (Date) —
Inclusive upper bound (YYYY-MM-DD). Defaults to today if omitted.
:limit (Integer) —
Page size (default 50) (default to 50)
:page (Integer) —
Page number (default 1) (default to 1)
:sort_by (String) —
Sort by date, engagement, or a specific metric (default to 'date')
:order (String) —
Sort order (default to 'desc')

Returns:

(Array<(GetAnalytics200Response, Integer, Hash)>) —
GetAnalytics200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 57

def get_analytics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_analytics ...'
  end
  allowable_values = ["all", "late", "external"]
  if @api_client.config.client_side_validation && opts[:'source'] && !allowable_values.include?(opts[:'source'])
    fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AnalyticsApi.get_analytics, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AnalyticsApi.get_analytics, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AnalyticsApi.get_analytics, must be greater than or equal to 1.'
  end

  allowable_values = ["date", "engagement", "impressions", "reach", "likes", "comments", "shares", "saves", "clicks", "views", "follows"]
  if @api_client.config.client_side_validation && opts[:'sort_by'] && !allowable_values.include?(opts[:'sort_by'])
    fail ArgumentError, "invalid value for \"sort_by\", must be one of #{allowable_values}"
  end
  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
    fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'postId'] = opts[:'post_id'] if !opts[:'post_id'].nil?
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
  query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAnalytics200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_analytics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_best_time_to_post(opts = {}) ⇒ `GetBestTimeToPost200Response`

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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:platform (String) —
Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
:profile_id (String) —
Filter by profile ID. Omit for all profiles.
:account_id (String) —
Filter by social account ID. Omit for all accounts.
:source (String) —
Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. (default to 'all')

Returns:

(GetBestTimeToPost200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 144

def get_best_time_to_post(opts = {})
  data, _status_code, _headers = get_best_time_to_post_with_http_info(opts)
  data
end

#get_best_time_to_post_with_http_info(opts = {}) ⇒ `Array<(GetBestTimeToPost200Response, Integer, Hash)>`

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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:platform (String) —
Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
:profile_id (String) —
Filter by profile ID. Omit for all profiles.
:account_id (String) —
Filter by social account ID. Omit for all accounts.
:source (String) —
Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. (default to 'all')

Returns:

(Array<(GetBestTimeToPost200Response, Integer, Hash)>) —
GetBestTimeToPost200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 157

def get_best_time_to_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_best_time_to_post ...'
  end
  allowable_values = ["all", "late", "external"]
  if @api_client.config.client_side_validation && opts[:'source'] && !allowable_values.include?(opts[:'source'])
    fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/best-time'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetBestTimeToPost200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_best_time_to_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_best_time_to_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_content_decay(opts = {}) ⇒ `GetContentDecay200Response`

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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:platform (String) —
Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
:profile_id (String) —
Filter by profile ID. Omit for all profiles.
:account_id (String) —
Filter by social account ID. Omit for all accounts.
:source (String) —
Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. (default to 'all')

Returns:

(GetContentDecay200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 217

def get_content_decay(opts = {})
  data, _status_code, _headers = get_content_decay_with_http_info(opts)
  data
end

#get_content_decay_with_http_info(opts = {}) ⇒ `Array<(GetContentDecay200Response, Integer, Hash)>`

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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:platform (String) —
Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
:profile_id (String) —
Filter by profile ID. Omit for all profiles.
:account_id (String) —
Filter by social account ID. Omit for all accounts.
:source (String) —
Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. (default to 'all')

Returns:

(Array<(GetContentDecay200Response, Integer, Hash)>) —
GetContentDecay200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 230

def get_content_decay_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_content_decay ...'
  end
  allowable_values = ["all", "late", "external"]
  if @api_client.config.client_side_validation && opts[:'source'] && !allowable_values.include?(opts[:'source'])
    fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/content-decay'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetContentDecay200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_content_decay",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_content_decay\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_daily_metrics(opts = {}) ⇒ `GetDailyMetrics200Response`

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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:platform (String) —
Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
:profile_id (String) —
Filter by profile ID. Omit for all profiles.
:account_id (String) —
Filter by social account ID
:from_date (Time) —
Inclusive start date (ISO 8601). Defaults to 180 days ago.
:to_date (Time) —
Inclusive end date (ISO 8601). Defaults to now.
:source (String) —
Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. (default to 'all')
:attribution (String) —
How each post's engagement is attributed to a day. "publish" (default) sums each post's lifetime total on its publish date. "received" buckets the per-day increase in engagement by the day it actually arrived (engagement-over-time), so engagement on older posts appears on the day it was gained rather than the post's publish date. (default to 'publish')

Returns:

(GetDailyMetrics200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 293

def get_daily_metrics(opts = {})
  data, _status_code, _headers = get_daily_metrics_with_http_info(opts)
  data
end

#get_daily_metrics_with_http_info(opts = {}) ⇒ `Array<(GetDailyMetrics200Response, Integer, Hash)>`

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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:platform (String) —
Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
:profile_id (String) —
Filter by profile ID. Omit for all profiles.
:account_id (String) —
Filter by social account ID
:from_date (Time) —
Inclusive start date (ISO 8601). Defaults to 180 days ago.
:to_date (Time) —
Inclusive end date (ISO 8601). Defaults to now.
:source (String) —
Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. (default to 'all')
:attribution (String) —
How each post's engagement is attributed to a day. "publish" (default) sums each post's lifetime total on its publish date. "received" buckets the per-day increase in engagement by the day it actually arrived (engagement-over-time), so engagement on older posts appears on the day it was gained rather than the post's publish date. (default to 'publish')

Returns:

(Array<(GetDailyMetrics200Response, Integer, Hash)>) —
GetDailyMetrics200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 309

def get_daily_metrics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_daily_metrics ...'
  end
  allowable_values = ["all", "late", "external"]
  if @api_client.config.client_side_validation && opts[:'source'] && !allowable_values.include?(opts[:'source'])
    fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
  end
  allowable_values = ["publish", "received"]
  if @api_client.config.client_side_validation && opts[:'attribution'] && !allowable_values.include?(opts[:'attribution'])
    fail ArgumentError, "invalid value for \"attribution\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/daily-metrics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
  query_params[:'attribution'] = opts[:'attribution'] if !opts[:'attribution'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetDailyMetrics200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_daily_metrics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_daily_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_facebook_page_insights(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

Get Facebook Page insights Returns page-level Facebook insights (media views, views, post engagements, video metrics, follower counts). Response shape matches /v1/analytics/instagram/account-insights so the same client handling works across platforms. Metric names track the current (post-November 2025) Meta Graph API. The legacy page_impressions / page_fans / page_fan_adds / page_fan_removes metrics were deprecated by Meta on November 15, 2025 and are NOT accepted by this endpoint. Use the replacements below. Because Meta did not provide direct adds/removes replacements, Zernio synthesizes followers_gained / followers_lost from the daily follower snapshotter. Max 89 days, defaults to last 30 days. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the connected Facebook Page.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list of metrics. Defaults to "page_media_view,page_post_engagements,page_follows,followers_gained,followers_lost". Live Meta metrics (current names, post-Nov-2025): - page_media_view (replaces deprecated page_impressions) - page_views_total - page_post_engagements - page_video_views - page_video_view_time - page_follows (replaces deprecated page_fans) Zernio-synthesized from daily follower snapshots (filling the Nov-2025 gap left by the page_fan_adds / page_fan_removes deprecation): - followers_gained - followers_lost
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (String) —
"total_value" (default) returns aggregated totals only. "time_series" returns daily values in the "values" array. (default to 'total_value')

Returns:

(InstagramAccountInsightsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 377

def get_facebook_page_insights(account_id, opts = {})
  data, _status_code, _headers = get_facebook_page_insights_with_http_info(account_id, opts)
  data
end

#get_facebook_page_insights_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

Get Facebook Page insights Returns page-level Facebook insights (media views, views, post engagements, video metrics, follower counts). Response shape matches /v1/analytics/instagram/account-insights so the same client handling works across platforms. Metric names track the current (post-November 2025) Meta Graph API. The legacy page_impressions / page_fans / page_fan_adds / page_fan_removes metrics were deprecated by Meta on November 15, 2025 and are NOT accepted by this endpoint. Use the replacements below. Because Meta did not provide direct adds/removes replacements, Zernio synthesizes followers_gained / followers_lost from the daily follower snapshotter. Max 89 days, defaults to last 30 days. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the connected Facebook Page.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list of metrics. Defaults to "page_media_view,page_post_engagements,page_follows,followers_gained,followers_lost". Live Meta metrics (current names, post-Nov-2025): - page_media_view (replaces deprecated page_impressions) - page_views_total - page_post_engagements - page_video_views - page_video_view_time - page_follows (replaces deprecated page_fans) Zernio-synthesized from daily follower snapshots (filling the Nov-2025 gap left by the page_fan_adds / page_fan_removes deprecation): - followers_gained - followers_lost
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (String) —
"total_value" (default) returns aggregated totals only. "time_series" returns daily values in the "values" array. (default to 'total_value')

Returns:

(Array<(InstagramAccountInsightsResponse, Integer, Hash)>) —
InstagramAccountInsightsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 391

def get_facebook_page_insights_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_facebook_page_insights ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_facebook_page_insights"
  end
  allowable_values = ["time_series", "total_value"]
  if @api_client.config.client_side_validation && opts[:'metric_type'] && !allowable_values.include?(opts[:'metric_type'])
    fail ArgumentError, "invalid value for \"metric_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/facebook/page-insights'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'metrics'] = opts[:'metrics'] if !opts[:'metrics'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'metricType'] = opts[:'metric_type'] if !opts[:'metric_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InstagramAccountInsightsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_facebook_page_insights",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_facebook_page_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_facebook_post_reactions(account_id, post_id, opts = {}) ⇒ `GetFacebookPostReactions200Response`

Get Facebook post reactions Returns the reaction breakdown for a Facebook Page post: a count per reaction type plus the overall total. The whole breakdown is fetched in a single Graph call. Note that the post analytics endpoint reports only an aggregate reaction count (surfaced there as likes), so use this endpoint when you need per-type counts.

Parameters:

account_id (String) —
The ID of the Facebook Page account
post_id (String) —
The Facebook post ID
opts (Hash) (defaults to: {}) —
the optional parameters

Returns:

(GetFacebookPostReactions200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 454

def get_facebook_post_reactions(account_id, post_id, opts = {})
  data, _status_code, _headers = get_facebook_post_reactions_with_http_info(account_id, post_id, opts)
  data
end

#get_facebook_post_reactions_with_http_info(account_id, post_id, opts = {}) ⇒ `Array<(GetFacebookPostReactions200Response, Integer, Hash)>`

Get Facebook post reactions Returns the reaction breakdown for a Facebook Page post: a count per reaction type plus the overall total. The whole breakdown is fetched in a single Graph call. Note that the post analytics endpoint reports only an aggregate reaction count (surfaced there as `likes`), so use this endpoint when you need per-type counts.

Parameters:

account_id (String) —
The ID of the Facebook Page account
post_id (String) —
The Facebook post ID
opts (Hash) (defaults to: {}) —
the optional parameters

Returns:

(Array<(GetFacebookPostReactions200Response, Integer, Hash)>) —
GetFacebookPostReactions200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 465

def get_facebook_post_reactions_with_http_info(account_id, post_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_facebook_post_reactions ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_facebook_post_reactions"
  end
  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling AnalyticsApi.get_facebook_post_reactions"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/facebook-post-reactions'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'postId'] = post_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetFacebookPostReactions200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_facebook_post_reactions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_facebook_post_reactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_follower_stats(opts = {}) ⇒ `FollowerStatsResponse`

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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:account_ids (String) —
Comma-separated list of account IDs (optional, defaults to all user's accounts)
:profile_id (String) —
Filter by profile ID
:from_date (Date) —
Start date in YYYY-MM-DD format (defaults to 30 days ago)
:to_date (Date) —
End date in YYYY-MM-DD format (defaults to today)
:granularity (String) —
Data aggregation level (default to 'daily')

Returns:

(FollowerStatsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 527

def get_follower_stats(opts = {})
  data, _status_code, _headers = get_follower_stats_with_http_info(opts)
  data
end

#get_follower_stats_with_http_info(opts = {}) ⇒ `Array<(FollowerStatsResponse, Integer, Hash)>`

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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:account_ids (String) —
Comma-separated list of account IDs (optional, defaults to all user's accounts)
:profile_id (String) —
Filter by profile ID
:from_date (Date) —
Start date in YYYY-MM-DD format (defaults to 30 days ago)
:to_date (Date) —
End date in YYYY-MM-DD format (defaults to today)
:granularity (String) —
Data aggregation level (default to 'daily')

Returns:

(Array<(FollowerStatsResponse, Integer, Hash)>) —
FollowerStatsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 541

def get_follower_stats_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_follower_stats ...'
  end
  allowable_values = ["daily", "weekly", "monthly"]
  if @api_client.config.client_side_validation && opts[:'granularity'] && !allowable_values.include?(opts[:'granularity'])
    fail ArgumentError, "invalid value for \"granularity\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/accounts/follower-stats'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountIds'] = opts[:'account_ids'] if !opts[:'account_ids'].nil?
  query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FollowerStatsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_follower_stats",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_follower_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_google_business_performance(account_id, opts = {}) ⇒ `GetGoogleBusinessPerformance200Response`

Get GBP performance metrics Returns daily performance metrics for a Google Business Profile location. Metrics include impressions (Maps/Search, desktop/mobile), website clicks, call clicks, direction requests, conversations, bookings, and food orders. Data may be delayed 2-3 days. Max 18 months of historical data. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the Google Business Profile account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated metric names. Defaults to all available metrics. Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH, BUSINESS_IMPRESSIONS_MOBILE_MAPS, BUSINESS_IMPRESSIONS_MOBILE_SEARCH, BUSINESS_CONVERSATIONS, BUSINESS_DIRECTION_REQUESTS, CALL_CLICKS, WEBSITE_CLICKS, BUSINESS_BOOKINGS, BUSINESS_FOOD_ORDERS, BUSINESS_FOOD_MENU_CLICKS
:start_date (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back.
:end_date (Date) —
End date (YYYY-MM-DD). Defaults to today.

Returns:

(GetGoogleBusinessPerformance200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 602

def get_google_business_performance(account_id, opts = {})
  data, _status_code, _headers = get_google_business_performance_with_http_info(account_id, opts)
  data
end

#get_google_business_performance_with_http_info(account_id, opts = {}) ⇒ `Array<(GetGoogleBusinessPerformance200Response, Integer, Hash)>`

Get GBP performance metrics Returns daily performance metrics for a Google Business Profile location. Metrics include impressions (Maps/Search, desktop/mobile), website clicks, call clicks, direction requests, conversations, bookings, and food orders. Data may be delayed 2-3 days. Max 18 months of historical data. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the Google Business Profile account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated metric names. Defaults to all available metrics. Valid values: BUSINESS_IMPRESSIONS_DESKTOP_MAPS, BUSINESS_IMPRESSIONS_DESKTOP_SEARCH, BUSINESS_IMPRESSIONS_MOBILE_MAPS, BUSINESS_IMPRESSIONS_MOBILE_SEARCH, BUSINESS_CONVERSATIONS, BUSINESS_DIRECTION_REQUESTS, CALL_CLICKS, WEBSITE_CLICKS, BUSINESS_BOOKINGS, BUSINESS_FOOD_ORDERS, BUSINESS_FOOD_MENU_CLICKS
:start_date (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago. Max 18 months back.
:end_date (Date) —
End date (YYYY-MM-DD). Defaults to today.

Returns:

(Array<(GetGoogleBusinessPerformance200Response, Integer, Hash)>) —
GetGoogleBusinessPerformance200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 615

def get_google_business_performance_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_google_business_performance ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_google_business_performance"
  end
  # resource path
  local_var_path = '/v1/analytics/googlebusiness/performance'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'metrics'] = opts[:'metrics'] if !opts[:'metrics'].nil?
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetGoogleBusinessPerformance200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_google_business_performance",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_google_business_performance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_google_business_search_keywords(account_id, opts = {}) ⇒ `GetGoogleBusinessSearchKeywords200Response`

Get GBP search keywords Returns search keywords that triggered impressions for a Google Business Profile location. Data is aggregated monthly. Keywords below a minimum impression threshold set by Google are excluded. Max 18 months of historical data. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the Google Business Profile account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:start_month (String) —
Start month (YYYY-MM). Defaults to 3 months ago.
:end_month (String) —
End month (YYYY-MM). Defaults to current month.

Returns:

(GetGoogleBusinessSearchKeywords200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 674

def get_google_business_search_keywords(account_id, opts = {})
  data, _status_code, _headers = get_google_business_search_keywords_with_http_info(account_id, opts)
  data
end

#get_google_business_search_keywords_with_http_info(account_id, opts = {}) ⇒ `Array<(GetGoogleBusinessSearchKeywords200Response, Integer, Hash)>`

Get GBP search keywords Returns search keywords that triggered impressions for a Google Business Profile location. Data is aggregated monthly. Keywords below a minimum impression threshold set by Google are excluded. Max 18 months of historical data. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the Google Business Profile account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:start_month (String) —
Start month (YYYY-MM). Defaults to 3 months ago.
:end_month (String) —
End month (YYYY-MM). Defaults to current month.

Returns:

(Array<(GetGoogleBusinessSearchKeywords200Response, Integer, Hash)>) —
GetGoogleBusinessSearchKeywords200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 686

def get_google_business_search_keywords_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_google_business_search_keywords ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_google_business_search_keywords"
  end
  pattern = Regexp.new(/^\d{4}-\d{2}$/)
  if @api_client.config.client_side_validation && !opts[:'start_month'].nil? && opts[:'start_month'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"start_month\"]' when calling AnalyticsApi.get_google_business_search_keywords, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/^\d{4}-\d{2}$/)
  if @api_client.config.client_side_validation && !opts[:'end_month'].nil? && opts[:'end_month'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"end_month\"]' when calling AnalyticsApi.get_google_business_search_keywords, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/analytics/googlebusiness/search-keywords'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'startMonth'] = opts[:'start_month'] if !opts[:'start_month'].nil?
  query_params[:'endMonth'] = opts[:'end_month'] if !opts[:'end_month'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetGoogleBusinessSearchKeywords200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_google_business_search_keywords",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_google_business_search_keywords\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_instagram_account_insights(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

Get Instagram 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:

account_id (String) —
The Zernio SocialAccount ID for the Instagram account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (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 (including follows_and_unfollows) are total_value only. This is an Instagram Graph API limitation, not a Zernio limitation - the IG API does not return time-series data for these metrics. For a daily running follower count, use /v1/analytics/instagram/follower-history instead.
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (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 (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.

Returns:

(InstagramAccountInsightsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 757

def get_instagram_account_insights(account_id, opts = {})
  data, _status_code, _headers = get_instagram_account_insights_with_http_info(account_id, opts)
  data
end

#get_instagram_account_insights_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

Get Instagram 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:

account_id (String) —
The Zernio SocialAccount ID for the Instagram account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (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 (including follows_and_unfollows) are total_value only. This is an Instagram Graph API limitation, not a Zernio limitation - the IG API does not return time-series data for these metrics. For a daily running follower count, use /v1/analytics/instagram/follower-history instead.
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (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 (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.

Returns:

(Array<(InstagramAccountInsightsResponse, Integer, Hash)>) —
InstagramAccountInsightsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 772

def get_instagram_account_insights_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_instagram_account_insights ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_instagram_account_insights"
  end
  allowable_values = ["time_series", "total_value"]
  if @api_client.config.client_side_validation && opts[:'metric_type'] && !allowable_values.include?(opts[:'metric_type'])
    fail ArgumentError, "invalid value for \"metric_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/instagram/account-insights'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'metrics'] = opts[:'metrics'] if !opts[:'metrics'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'metricType'] = opts[:'metric_type'] if !opts[:'metric_type'].nil?
  query_params[:'breakdown'] = opts[:'breakdown'] if !opts[:'breakdown'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InstagramAccountInsightsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_instagram_account_insights",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_instagram_account_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_instagram_demographics(account_id, opts = {}) ⇒ `InstagramDemographicsResponse`

Get Instagram 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:

account_id (String) —
The Zernio SocialAccount ID for the Instagram account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metric (String) —
"follower_demographics" for follower audience data, or "engaged_audience_demographics" for engaged viewers. (default to 'follower_demographics')
:breakdown (String) —
Comma-separated list of demographic dimensions: age, city, country, gender. Defaults to all four if omitted.
:timeframe (String) —
Time period for demographic data. Defaults to "this_month". (default to 'this_month')

Returns:

(InstagramDemographicsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 838

def get_instagram_demographics(account_id, opts = {})
  data, _status_code, _headers = get_instagram_demographics_with_http_info(account_id, opts)
  data
end

#get_instagram_demographics_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramDemographicsResponse, Integer, Hash)>`

Get Instagram 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:

account_id (String) —
The Zernio SocialAccount ID for the Instagram account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metric (String) —
"follower_demographics" for follower audience data, or "engaged_audience_demographics" for engaged viewers. (default to 'follower_demographics')
:breakdown (String) —
Comma-separated list of demographic dimensions: age, city, country, gender. Defaults to all four if omitted.
:timeframe (String) —
Time period for demographic data. Defaults to "this_month". (default to 'this_month')

Returns:

(Array<(InstagramDemographicsResponse, Integer, Hash)>) —
InstagramDemographicsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 851

def get_instagram_demographics_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_instagram_demographics ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_instagram_demographics"
  end
  allowable_values = ["follower_demographics", "engaged_audience_demographics"]
  if @api_client.config.client_side_validation && opts[:'metric'] && !allowable_values.include?(opts[:'metric'])
    fail ArgumentError, "invalid value for \"metric\", must be one of #{allowable_values}"
  end
  allowable_values = ["this_week", "this_month"]
  if @api_client.config.client_side_validation && opts[:'timeframe'] && !allowable_values.include?(opts[:'timeframe'])
    fail ArgumentError, "invalid value for \"timeframe\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/instagram/demographics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'metric'] = opts[:'metric'] if !opts[:'metric'].nil?
  query_params[:'breakdown'] = opts[:'breakdown'] if !opts[:'breakdown'].nil?
  query_params[:'timeframe'] = opts[:'timeframe'] if !opts[:'timeframe'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InstagramDemographicsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_instagram_demographics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_instagram_demographics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_instagram_follower_history(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

Get Instagram follower history Returns a daily running Instagram follower count time series, served from Zernio's cross-platform daily snapshotter. Exists because Meta removed follower_count from the /insights endpoint in Graph API v22+ and never exposed a historical daily series via any public API. Response envelope matches /v1/analytics/instagram/account-insights so the same client handling works. Max 89 days, defaults to last 30 days. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the Instagram account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list. Defaults to "follower_count,followers_gained,followers_lost". - follower_count : per-day raw follower count - followers_gained : sum of positive daily deltas - followers_lost : sum of absolute negative daily deltas
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (String) —
"total_value" returns aggregated totals (latest for follower_count, sum for gained/lost). "time_series" returns per-day values in the "values" array. (default to 'total_value')

Returns:

(InstagramAccountInsightsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 920

def get_instagram_follower_history(account_id, opts = {})
  data, _status_code, _headers = get_instagram_follower_history_with_http_info(account_id, opts)
  data
end

#get_instagram_follower_history_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

Get Instagram follower history Returns a daily running Instagram follower count time series, served from Zernio's cross-platform daily snapshotter. Exists because Meta removed follower_count from the /insights endpoint in Graph API v22+ and never exposed a historical daily series via any public API. Response envelope matches /v1/analytics/instagram/account-insights so the same client handling works. Max 89 days, defaults to last 30 days. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the Instagram account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list. Defaults to "follower_count,followers_gained,followers_lost". - follower_count : per-day raw follower count - followers_gained : sum of positive daily deltas - followers_lost : sum of absolute negative daily deltas
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (String) —
"total_value" returns aggregated totals (latest for follower_count, sum for gained/lost). "time_series" returns per-day values in the "values" array. (default to 'total_value')

Returns:

(Array<(InstagramAccountInsightsResponse, Integer, Hash)>) —
InstagramAccountInsightsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 934

def get_instagram_follower_history_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_instagram_follower_history ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_instagram_follower_history"
  end
  allowable_values = ["time_series", "total_value"]
  if @api_client.config.client_side_validation && opts[:'metric_type'] && !allowable_values.include?(opts[:'metric_type'])
    fail ArgumentError, "invalid value for \"metric_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/instagram/follower-history'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'metrics'] = opts[:'metrics'] if !opts[:'metrics'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'metricType'] = opts[:'metric_type'] if !opts[:'metric_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InstagramAccountInsightsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_instagram_follower_history",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_instagram_follower_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_linked_in_aggregate_analytics(account_id, opts = {}) ⇒ `GetLinkedInAggregateAnalytics200Response`

Get LinkedIn aggregate stats Returns aggregate analytics across all posts for a LinkedIn personal account. Only includes posts published through Zernio (LinkedIn API limitation). Org accounts should use /v1/analytics instead. Requires r_member_postAnalytics scope. Saves (POST_SAVE) and sends (POST_SEND) are available for personal accounts; organization pages always return 0 for these two metrics because LinkedIn does not expose them on the organization analytics endpoint.

Parameters:

account_id (String) —
The ID of the LinkedIn personal account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:aggregation (String) —
TOTAL (default, lifetime totals) or DAILY (time series). MEMBERS_REACHED not available with DAILY. (default to 'TOTAL')
:start_date (Date) —
Start date (YYYY-MM-DD). If omitted, returns lifetime analytics.
:end_date (Date) —
End date (YYYY-MM-DD, exclusive). Defaults to today if omitted.
:metrics (String) —
Comma-separated metrics: IMPRESSION, MEMBERS_REACHED, REACTION, COMMENT, RESHARE, POST_SAVE, POST_SEND. Omit for all.

Returns:

(GetLinkedInAggregateAnalytics200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1000

def get_linked_in_aggregate_analytics(account_id, opts = {})
  data, _status_code, _headers = get_linked_in_aggregate_analytics_with_http_info(account_id, opts)
  data
end

#get_linked_in_aggregate_analytics_with_http_info(account_id, opts = {}) ⇒ `Array<(GetLinkedInAggregateAnalytics200Response, Integer, Hash)>`

Get LinkedIn aggregate stats Returns aggregate analytics across all posts for a LinkedIn personal account. Only includes posts published through Zernio (LinkedIn API limitation). Org accounts should use /v1/analytics instead. Requires r_member_postAnalytics scope. Saves (POST_SAVE) and sends (POST_SEND) are available for personal accounts; organization pages always return 0 for these two metrics because LinkedIn does not expose them on the organization analytics endpoint.

Parameters:

account_id (String) —
The ID of the LinkedIn personal account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:aggregation (String) —
TOTAL (default, lifetime totals) or DAILY (time series). MEMBERS_REACHED not available with DAILY. (default to 'TOTAL')
:start_date (Date) —
Start date (YYYY-MM-DD). If omitted, returns lifetime analytics.
:end_date (Date) —
End date (YYYY-MM-DD, exclusive). Defaults to today if omitted.
:metrics (String) —
Comma-separated metrics: IMPRESSION, MEMBERS_REACHED, REACTION, COMMENT, RESHARE, POST_SAVE, POST_SEND. Omit for all.

Returns:

(Array<(GetLinkedInAggregateAnalytics200Response, Integer, Hash)>) —
GetLinkedInAggregateAnalytics200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1014

def get_linked_in_aggregate_analytics_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_linked_in_aggregate_analytics ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_linked_in_aggregate_analytics"
  end
  allowable_values = ["TOTAL", "DAILY"]
  if @api_client.config.client_side_validation && opts[:'aggregation'] && !allowable_values.include?(opts[:'aggregation'])
    fail ArgumentError, "invalid value for \"aggregation\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/linkedin-aggregate-analytics'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'aggregation'] = opts[:'aggregation'] if !opts[:'aggregation'].nil?
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'metrics'] = opts[:'metrics'] if !opts[:'metrics'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetLinkedInAggregateAnalytics200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_linked_in_aggregate_analytics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_linked_in_aggregate_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_linked_in_org_aggregate_analytics(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

Get LinkedIn org analytics Returns aggregate analytics for a LinkedIn organization page. Parallel to /v1/accounts/id/linkedin-aggregate-analytics (which handles personal accounts only). Backed by LinkedIn's organizationalEntityShareStatistics, organizationalEntityFollowerStatistics, and organizationPageStatistics endpoints. Response shape matches /v1/analytics/instagram/account-insights. Max 89 days, defaults to last 30 days. Requires the Analytics add-on. Scope requirements: r_organization_social, r_organization_followers, and r_organization_admin must all be present on the account. Accounts connected before these scopes were included in the OAuth flow will return 412 with a reauth hint. Enforced by this endpoint: - Page-view metrics accept only metricType=total_value (LinkedIn omits per-day segmentation even when the API is called with DAY granularity, so a time-series response would be meaningless). - Date range capped at 89 days. LinkedIn-side platform limits (not re-enforced here, but worth knowing for larger ranges in a future release): - Follower stats: rolling 12-month window, end must be no later than 2 days ago. - Share stats: rolling 12-month window.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the LinkedIn organization account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list. Defaults to "impressions,clicks,engagement_rate,organic_followers_gained,followers_gained,followers_lost". Share statistics (support both total_value and time_series): - impressions - unique_impressions - clicks - likes - comments - shares - engagement_rate (0..1, LinkedIn-computed) Follower-gain statistics (support total_value and time_series): - organic_followers_gained (per-day organic gains for time_series; sum of organic gains over the range for total_value) - paid_followers_gained (per-day paid gains for time_series; sum of paid gains over the range for total_value) Page-view statistics (total_value ONLY - LinkedIn platform limit): - page_views_total - page_views_overview - page_views_careers - page_views_jobs - page_views_life Zernio-synthesized from daily follower snapshots: - followers_gained - followers_lost
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (String) — default: default to 'total_value'

Returns:

(InstagramAccountInsightsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1079

def get_linked_in_org_aggregate_analytics(account_id, opts = {})
  data, _status_code, _headers = get_linked_in_org_aggregate_analytics_with_http_info(account_id, opts)
  data
end

#get_linked_in_org_aggregate_analytics_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

Get LinkedIn org analytics Returns aggregate analytics for a LinkedIn organization page. Parallel to /v1/accounts/id/linkedin-aggregate-analytics (which handles personal accounts only). Backed by LinkedIn's organizationalEntityShareStatistics, organizationalEntityFollowerStatistics, and organizationPageStatistics endpoints. Response shape matches /v1/analytics/instagram/account-insights. Max 89 days, defaults to last 30 days. Requires the Analytics add-on. Scope requirements: r_organization_social, r_organization_followers, and r_organization_admin must all be present on the account. Accounts connected before these scopes were included in the OAuth flow will return 412 with a reauth hint. Enforced by this endpoint: - Page-view metrics accept only metricType=total_value (LinkedIn omits per-day segmentation even when the API is called with DAY granularity, so a time-series response would be meaningless). - Date range capped at 89 days. LinkedIn-side platform limits (not re-enforced here, but worth knowing for larger ranges in a future release): - Follower stats: rolling 12-month window, end must be no later than 2 days ago. - Share stats: rolling 12-month window.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the LinkedIn organization account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list. Defaults to "impressions,clicks,engagement_rate,organic_followers_gained,followers_gained,followers_lost". Share statistics (support both total_value and time_series): - impressions - unique_impressions - clicks - likes - comments - shares - engagement_rate (0..1, LinkedIn-computed) Follower-gain statistics (support total_value and time_series): - organic_followers_gained (per-day organic gains for time_series; sum of organic gains over the range for total_value) - paid_followers_gained (per-day paid gains for time_series; sum of paid gains over the range for total_value) Page-view statistics (total_value ONLY - LinkedIn platform limit): - page_views_total - page_views_overview - page_views_careers - page_views_jobs - page_views_life Zernio-synthesized from daily follower snapshots: - followers_gained - followers_lost
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (String) — default: default to 'total_value'

Returns:

(Array<(InstagramAccountInsightsResponse, Integer, Hash)>) —
InstagramAccountInsightsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1093

def get_linked_in_org_aggregate_analytics_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_linked_in_org_aggregate_analytics ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_linked_in_org_aggregate_analytics"
  end
  allowable_values = ["time_series", "total_value"]
  if @api_client.config.client_side_validation && opts[:'metric_type'] && !allowable_values.include?(opts[:'metric_type'])
    fail ArgumentError, "invalid value for \"metric_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/linkedin/org-aggregate-analytics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'metrics'] = opts[:'metrics'] if !opts[:'metrics'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'metricType'] = opts[:'metric_type'] if !opts[:'metric_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InstagramAccountInsightsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_linked_in_org_aggregate_analytics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_linked_in_org_aggregate_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_linked_in_post_analytics(account_id, urn, opts = {}) ⇒ `GetLinkedInPostAnalytics200Response`

Get LinkedIn post stats Returns analytics for a specific LinkedIn post by URN. Works for both personal and organization accounts. Saves and sends are only populated for personal accounts (LinkedIn does not expose these metrics on the organization analytics endpoint).

Parameters:

account_id (String) —
The ID of the LinkedIn account
urn (String) —
The LinkedIn post URN
opts (Hash) (defaults to: {}) —
the optional parameters

Returns:

(GetLinkedInPostAnalytics200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1156

def get_linked_in_post_analytics(account_id, urn, opts = {})
  data, _status_code, _headers = get_linked_in_post_analytics_with_http_info(account_id, urn, opts)
  data
end

#get_linked_in_post_analytics_with_http_info(account_id, urn, opts = {}) ⇒ `Array<(GetLinkedInPostAnalytics200Response, Integer, Hash)>`

Get LinkedIn post stats Returns analytics for a specific LinkedIn post by URN. Works for both personal and organization accounts. Saves and sends are only populated for personal accounts (LinkedIn does not expose these metrics on the organization analytics endpoint).

Parameters:

account_id (String) —
The ID of the LinkedIn account
urn (String) —
The LinkedIn post URN
opts (Hash) (defaults to: {}) —
the optional parameters

Returns:

(Array<(GetLinkedInPostAnalytics200Response, Integer, Hash)>) —
GetLinkedInPostAnalytics200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1167

def get_linked_in_post_analytics_with_http_info(account_id, urn, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_linked_in_post_analytics ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_linked_in_post_analytics"
  end
  # verify the required parameter 'urn' is set
  if @api_client.config.client_side_validation && urn.nil?
    fail ArgumentError, "Missing the required parameter 'urn' when calling AnalyticsApi.get_linked_in_post_analytics"
  end
  # resource path
  local_var_path = '/v1/accounts/{accountId}/linkedin-post-analytics'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'urn'] = urn

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetLinkedInPostAnalytics200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_linked_in_post_analytics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_linked_in_post_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_linked_in_post_reactions(account_id, urn, opts = {}) ⇒ `GetLinkedInPostReactions200Response`

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:

account_id (String) —
The ID of the LinkedIn organization account
urn (String) —
The LinkedIn post URN
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:limit (Integer) —
Maximum number of reactions to return per page (default to 25)
:cursor (String) —
Offset-based pagination start index

Returns:

(GetLinkedInPostReactions200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1228

def get_linked_in_post_reactions(account_id, urn, opts = {})
  data, _status_code, _headers = get_linked_in_post_reactions_with_http_info(account_id, urn, opts)
  data
end

#get_linked_in_post_reactions_with_http_info(account_id, urn, opts = {}) ⇒ `Array<(GetLinkedInPostReactions200Response, Integer, Hash)>`

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:

account_id (String) —
The ID of the LinkedIn organization account
urn (String) —
The LinkedIn post URN
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:limit (Integer) —
Maximum number of reactions to return per page (default to 25)
:cursor (String) —
Offset-based pagination start index

Returns:

(Array<(GetLinkedInPostReactions200Response, Integer, Hash)>) —
GetLinkedInPostReactions200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1241

def get_linked_in_post_reactions_with_http_info(account_id, urn, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_linked_in_post_reactions ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_linked_in_post_reactions"
  end
  # verify the required parameter 'urn' is set
  if @api_client.config.client_side_validation && urn.nil?
    fail ArgumentError, "Missing the required parameter 'urn' when calling AnalyticsApi.get_linked_in_post_reactions"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AnalyticsApi.get_linked_in_post_reactions, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AnalyticsApi.get_linked_in_post_reactions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/accounts/{accountId}/linkedin-post-reactions'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'urn'] = urn
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetLinkedInPostReactions200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_linked_in_post_reactions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_linked_in_post_reactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_post_timeline(post_id, opts = {}) ⇒ `GetPostTimeline200Response`

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:

post_id (String) —
The post to fetch timeline for. Accepts an ExternalPost ID, a platformPostId, or a Zernio Post ID.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:from_date (Time) —
Start of date range (ISO 8601). Defaults to 90 days ago.
:to_date (Time) —
End of date range (ISO 8601). Defaults to now.

Returns:

(GetPostTimeline200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1311

def get_post_timeline(post_id, opts = {})
  data, _status_code, _headers = get_post_timeline_with_http_info(post_id, opts)
  data
end

#get_post_timeline_with_http_info(post_id, opts = {}) ⇒ `Array<(GetPostTimeline200Response, Integer, Hash)>`

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:

post_id (String) —
The post to fetch timeline for. Accepts an ExternalPost ID, a platformPostId, or a Zernio Post ID.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:from_date (Time) —
Start of date range (ISO 8601). Defaults to 90 days ago.
:to_date (Time) —
End of date range (ISO 8601). Defaults to now.

Returns:

(Array<(GetPostTimeline200Response, Integer, Hash)>) —
GetPostTimeline200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1323

def get_post_timeline_with_http_info(post_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_post_timeline ...'
  end
  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling AnalyticsApi.get_post_timeline"
  end
  # resource path
  local_var_path = '/v1/analytics/post-timeline'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'postId'] = post_id
  query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
  query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetPostTimeline200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_post_timeline",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_post_timeline\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_posting_frequency(opts = {}) ⇒ `GetPostingFrequency200Response`

Get 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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:platform (String) —
Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
:profile_id (String) —
Filter by profile ID. Omit for all profiles.
:account_id (String) —
Filter by social account ID. Omit for all accounts.
:source (String) —
Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. (default to 'all')

Returns:

(GetPostingFrequency200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1382

def get_posting_frequency(opts = {})
  data, _status_code, _headers = get_posting_frequency_with_http_info(opts)
  data
end

#get_posting_frequency_with_http_info(opts = {}) ⇒ `Array<(GetPostingFrequency200Response, Integer, Hash)>`

Get 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:

opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:platform (String) —
Filter by platform (e.g. "instagram", "tiktok"). Omit for all platforms.
:profile_id (String) —
Filter by profile ID. Omit for all profiles.
:account_id (String) —
Filter by social account ID. Omit for all accounts.
:source (String) —
Filter by post origin. "late" for posts published via Zernio, "external" for posts imported from platforms. (default to 'all')

Returns:

(Array<(GetPostingFrequency200Response, Integer, Hash)>) —
GetPostingFrequency200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1395

def get_posting_frequency_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_posting_frequency ...'
  end
  allowable_values = ["all", "late", "external"]
  if @api_client.config.client_side_validation && opts[:'source'] && !allowable_values.include?(opts[:'source'])
    fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/posting-frequency'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'profileId'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetPostingFrequency200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_posting_frequency",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_posting_frequency\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tik_tok_account_insights(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

Get TikTok account-level insights Returns account-level TikTok insights from /v2/user/info/ (live) plus historical time series joined from Zernio's daily snapshotter (AccountStats). Response shape matches /v1/analytics/instagram/account-insights. Max 89 days, defaults to last 30 days. Requires the Analytics add-on and the user.info.stats scope on the account (412 if missing). Scope intentionally narrow. TikTok's public API exposes only the four counter metrics below. The deep metrics that live in TikTok Studio are NOT available on any public TikTok API, even for Business accounts: - profile_views - account-level impressions / reach - follower inflow / outflow breakdown - video watch time, average watch time, full-watched rate - impression_sources (FYP / Following / Hashtag / Search / Personal profile) TikTok's Research API doesn't expose those fields either, and is restricted to non-commercial academic use per TikTok's eligibility policy. There is no public API workaround. Post-level metrics (views, likes, comments, shares per video) are available via /v1/analytics?postId=... from TikTok's /v2/video/query/.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the TikTok account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list. Defaults to "follower_count,likes_count,video_count,followers_gained,followers_lost". Live from /v2/user/info/ (requires user.info.stats scope): - follower_count (cumulative; time series joined from AccountStats) - following_count (cumulative; time series joined from AccountStats.metadata) - likes_count (cumulative; time series joined from AccountStats.metadata) - video_count (cumulative; time series joined from AccountStats.metadata) Zernio-synthesized: - followers_gained (sum of positive daily follower deltas) - followers_lost (sum of absolute negative daily deltas)
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (String) —
"total_value" returns the latest cumulative counter value. "time_series" returns daily values joined from AccountStats snapshots. (default to 'total_value')

Returns:

(InstagramAccountInsightsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1456

def get_tik_tok_account_insights(account_id, opts = {})
  data, _status_code, _headers = get_tik_tok_account_insights_with_http_info(account_id, opts)
  data
end

#get_tik_tok_account_insights_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

Get TikTok account-level insights Returns account-level TikTok insights from /v2/user/info/ (live) plus historical time series joined from Zernio's daily snapshotter (AccountStats). Response shape matches /v1/analytics/instagram/account-insights. Max 89 days, defaults to last 30 days. Requires the Analytics add-on and the user.info.stats scope on the account (412 if missing). Scope intentionally narrow. TikTok's public API exposes only the four counter metrics below. The deep metrics that live in TikTok Studio are NOT available on any public TikTok API, even for Business accounts: - profile_views - account-level impressions / reach - follower inflow / outflow breakdown - video watch time, average watch time, full-watched rate - impression_sources (FYP / Following / Hashtag / Search / Personal profile) TikTok's Research API doesn't expose those fields either, and is restricted to non-commercial academic use per TikTok's eligibility policy. There is no public API workaround. Post-level metrics (views, likes, comments, shares per video) are available via /v1/analytics?postId=... from TikTok's /v2/video/query/.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the TikTok account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list. Defaults to "follower_count,likes_count,video_count,followers_gained,followers_lost". Live from /v2/user/info/ (requires user.info.stats scope): - follower_count (cumulative; time series joined from AccountStats) - following_count (cumulative; time series joined from AccountStats.metadata) - likes_count (cumulative; time series joined from AccountStats.metadata) - video_count (cumulative; time series joined from AccountStats.metadata) Zernio-synthesized: - followers_gained (sum of positive daily follower deltas) - followers_lost (sum of absolute negative daily deltas)
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today.
:metric_type (String) —
"total_value" returns the latest cumulative counter value. "time_series" returns daily values joined from AccountStats snapshots. (default to 'total_value')

Returns:

(Array<(InstagramAccountInsightsResponse, Integer, Hash)>) —
InstagramAccountInsightsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1470

def get_tik_tok_account_insights_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_tik_tok_account_insights ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_tik_tok_account_insights"
  end
  allowable_values = ["time_series", "total_value"]
  if @api_client.config.client_side_validation && opts[:'metric_type'] && !allowable_values.include?(opts[:'metric_type'])
    fail ArgumentError, "invalid value for \"metric_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/tiktok/account-insights'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'metrics'] = opts[:'metrics'] if !opts[:'metrics'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'metricType'] = opts[:'metric_type'] if !opts[:'metric_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InstagramAccountInsightsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_tik_tok_account_insights",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_tik_tok_account_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_you_tube_channel_insights(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

Get YouTube channel insights Returns channel-scoped aggregate metrics from YouTube Analytics API v2. Saves you from looping /v1/analytics/youtube/daily-views over every video when you only need channel totals. Response shape matches /v1/analytics/instagram/account-insights so the same client handling works. Requires yt-analytics.readonly scope (412 with reauthorizeUrl if missing). Data has a 2-3 day delay (endDate is clamped accordingly). Max 89 days, defaults to last 30 days. Requires the Analytics add-on. NOT exposed: impressions (Studio thumbnail impressions) and impressionsClickThroughRate. YouTube Analytics API v2 does not expose these for any principal type, not channel owners, not Partner Program channels, not content owners with CMS access. The only way to get them is Studio CSV export. This is a Google-side limitation.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the YouTube account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list. Defaults to "views,estimatedMinutesWatched,subscribersGained,subscribersLost". Live YouTube Analytics v2 metrics: - views - estimatedMinutesWatched - averageViewDuration (ratio - weighted mean computed across days) - subscribersGained - subscribersLost Zernio-synthesized from daily follower snapshots (cross-platform parity): - followers_gained - followers_lost
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today. YouTube Analytics has a 2-3 day delay, so the fetch is internally clamped to 3 days ago; any requested range extending beyond that returns zero values for the tail days. The response's dateRange.until field reflects your requested value.
:metric_type (String) —
"total_value" (default) returns aggregated totals. "time_series" returns per-day values in the "values" array. (default to 'total_value')

Returns:

(InstagramAccountInsightsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1536

def get_you_tube_channel_insights(account_id, opts = {})
  data, _status_code, _headers = get_you_tube_channel_insights_with_http_info(account_id, opts)
  data
end

#get_you_tube_channel_insights_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

Get YouTube channel insights Returns channel-scoped aggregate metrics from YouTube Analytics API v2. Saves you from looping /v1/analytics/youtube/daily-views over every video when you only need channel totals. Response shape matches /v1/analytics/instagram/account-insights so the same client handling works. Requires yt-analytics.readonly scope (412 with reauthorizeUrl if missing). Data has a 2-3 day delay (endDate is clamped accordingly). Max 89 days, defaults to last 30 days. Requires the Analytics add-on. NOT exposed: impressions (Studio thumbnail impressions) and impressionsClickThroughRate. YouTube Analytics API v2 does not expose these for any principal type, not channel owners, not Partner Program channels, not content owners with CMS access. The only way to get them is Studio CSV export. This is a Google-side limitation.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the YouTube account.
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:metrics (String) —
Comma-separated list. Defaults to "views,estimatedMinutesWatched,subscribersGained,subscribersLost". Live YouTube Analytics v2 metrics: - views - estimatedMinutesWatched - averageViewDuration (ratio - weighted mean computed across days) - subscribersGained - subscribersLost Zernio-synthesized from daily follower snapshots (cross-platform parity): - followers_gained - followers_lost
:since (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:_until (Date) —
End date (YYYY-MM-DD). Defaults to today. YouTube Analytics has a 2-3 day delay, so the fetch is internally clamped to 3 days ago; any requested range extending beyond that returns zero values for the tail days. The response's dateRange.until field reflects your requested value.
:metric_type (String) —
"total_value" (default) returns aggregated totals. "time_series" returns per-day values in the "values" array. (default to 'total_value')

Returns:

(Array<(InstagramAccountInsightsResponse, Integer, Hash)>) —
InstagramAccountInsightsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1550

def get_you_tube_channel_insights_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_you_tube_channel_insights ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_you_tube_channel_insights"
  end
  allowable_values = ["time_series", "total_value"]
  if @api_client.config.client_side_validation && opts[:'metric_type'] && !allowable_values.include?(opts[:'metric_type'])
    fail ArgumentError, "invalid value for \"metric_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/analytics/youtube/channel-insights'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'metrics'] = opts[:'metrics'] if !opts[:'metrics'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'metricType'] = opts[:'metric_type'] if !opts[:'metric_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InstagramAccountInsightsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_you_tube_channel_insights",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_you_tube_channel_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_you_tube_daily_views(video_id, account_id, opts = {}) ⇒ `YouTubeDailyViewsResponse`

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:

video_id (String) —
The YouTube video ID (e.g., "dQw4w9WgXcQ")
account_id (String) —
The Zernio account ID for the YouTube account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:start_date (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:end_date (Date) —
End date (YYYY-MM-DD). Defaults to 3 days ago (YouTube data latency).

Returns:

(YouTubeDailyViewsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1615

def get_you_tube_daily_views(video_id, account_id, opts = {})
  data, _status_code, _headers = get_you_tube_daily_views_with_http_info(video_id, account_id, opts)
  data
end

#get_you_tube_daily_views_with_http_info(video_id, account_id, opts = {}) ⇒ `Array<(YouTubeDailyViewsResponse, Integer, Hash)>`

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:

video_id (String) —
The YouTube video ID (e.g., "dQw4w9WgXcQ")
account_id (String) —
The Zernio account ID for the YouTube account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:start_date (Date) —
Start date (YYYY-MM-DD). Defaults to 30 days ago.
:end_date (Date) —
End date (YYYY-MM-DD). Defaults to 3 days ago (YouTube data latency).

Returns:

(Array<(YouTubeDailyViewsResponse, Integer, Hash)>) —
YouTubeDailyViewsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1628

def get_you_tube_daily_views_with_http_info(video_id, account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_you_tube_daily_views ...'
  end
  # verify the required parameter 'video_id' is set
  if @api_client.config.client_side_validation && video_id.nil?
    fail ArgumentError, "Missing the required parameter 'video_id' when calling AnalyticsApi.get_you_tube_daily_views"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_you_tube_daily_views"
  end
  # resource path
  local_var_path = '/v1/analytics/youtube/daily-views'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'videoId'] = video_id
  query_params[:'accountId'] = account_id
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'YouTubeDailyViewsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_you_tube_daily_views",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_you_tube_daily_views\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_you_tube_demographics(account_id, opts = {}) ⇒ `YouTubeDemographicsResponse`

Get YouTube demographics Returns audience demographic insights for a YouTube channel, broken down by age, gender, and/or country. Pass videoId to get the audience profile of a single video instead of the whole channel. Age and gender values are viewer percentages (0-100). Country values are view counts. Data is based on signed-in viewers only, with a 2-3 day delay. YouTube suppresses demographics for videos with too few signed-in views, so low-traffic videos can return empty breakdowns. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the YouTube account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:video_id (String) —
YouTube video ID. When provided, demographics are scoped to this single video (must belong to the connected channel; otherwise 404 video_not_found).
:breakdown (String) —
Comma-separated list of demographic dimensions: age, gender, country. Defaults to all three if omitted.
:start_date (Date) —
Start date in YYYY-MM-DD format. Defaults to 90 days ago, or to the video's publish date (lifetime) when videoId is provided.
:end_date (Date) —
End date in YYYY-MM-DD format. Defaults to 3 days ago (YouTube data latency).

Returns:

(YouTubeDemographicsResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1693

def get_you_tube_demographics(account_id, opts = {})
  data, _status_code, _headers = get_you_tube_demographics_with_http_info(account_id, opts)
  data
end

#get_you_tube_demographics_with_http_info(account_id, opts = {}) ⇒ `Array<(YouTubeDemographicsResponse, Integer, Hash)>`

Get YouTube demographics Returns audience demographic insights for a YouTube channel, broken down by age, gender, and/or country. Pass videoId to get the audience profile of a single video instead of the whole channel. Age and gender values are viewer percentages (0-100). Country values are view counts. Data is based on signed-in viewers only, with a 2-3 day delay. YouTube suppresses demographics for videos with too few signed-in views, so low-traffic videos can return empty breakdowns. Requires the Analytics add-on.

Parameters:

account_id (String) —
The Zernio SocialAccount ID for the YouTube account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:video_id (String) —
YouTube video ID. When provided, demographics are scoped to this single video (must belong to the connected channel; otherwise 404 video_not_found).
:breakdown (String) —
Comma-separated list of demographic dimensions: age, gender, country. Defaults to all three if omitted.
:start_date (Date) —
Start date in YYYY-MM-DD format. Defaults to 90 days ago, or to the video's publish date (lifetime) when videoId is provided.
:end_date (Date) —
End date in YYYY-MM-DD format. Defaults to 3 days ago (YouTube data latency).

Returns:

(Array<(YouTubeDemographicsResponse, Integer, Hash)>) —
YouTubeDemographicsResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1707

def get_you_tube_demographics_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_you_tube_demographics ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_you_tube_demographics"
  end
  # resource path
  local_var_path = '/v1/analytics/youtube/demographics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = account_id
  query_params[:'videoId'] = opts[:'video_id'] if !opts[:'video_id'].nil?
  query_params[:'breakdown'] = opts[:'breakdown'] if !opts[:'breakdown'].nil?
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'YouTubeDemographicsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_you_tube_demographics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_you_tube_demographics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_you_tube_video_retention(video_id, account_id, opts = {}) ⇒ `YouTubeVideoRetentionResponse`

Get YouTube video retention curve Returns the audience retention curve for a single YouTube video, plus the video's duration for rendering the curve on a time axis. The curve has up to 100 points (elapsedVideoTimeRatio 0.01-1.0) aggregated over the whole date range; YouTube does not support per-day retention breakdowns. audienceWatchRatio is the absolute share of viewers watching at that point in the video and can exceed 1 (rewinds and looping, common on Shorts). relativeRetentionPerformance compares against videos of similar length (0 = worst, 0.5 = median, 1 = best). YouTube returns an empty curve for videos with very few views or before analytics processing completes (2-3 day delay). Requires yt-analytics.readonly scope (re-authorization may be needed).

Parameters:

video_id (String) —
The YouTube video ID (e.g., "dQw4w9WgXcQ")
account_id (String) —
The Zernio account ID for the YouTube account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:start_date (Date) —
Start date (YYYY-MM-DD). Defaults to the video's publish date (lifetime curve).
:end_date (Date) —
End date (YYYY-MM-DD). Defaults to 3 days ago (YouTube data latency).

Returns:

(YouTubeVideoRetentionResponse)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1768

def get_you_tube_video_retention(video_id, account_id, opts = {})
  data, _status_code, _headers = get_you_tube_video_retention_with_http_info(video_id, account_id, opts)
  data
end

#get_you_tube_video_retention_with_http_info(video_id, account_id, opts = {}) ⇒ `Array<(YouTubeVideoRetentionResponse, Integer, Hash)>`

Get YouTube video retention curve Returns the audience retention curve for a single YouTube video, plus the video's duration for rendering the curve on a time axis. The curve has up to 100 points (elapsedVideoTimeRatio 0.01-1.0) aggregated over the whole date range; YouTube does not support per-day retention breakdowns. audienceWatchRatio is the absolute share of viewers watching at that point in the video and can exceed 1 (rewinds and looping, common on Shorts). relativeRetentionPerformance compares against videos of similar length (0 = worst, 0.5 = median, 1 = best). YouTube returns an empty curve for videos with very few views or before analytics processing completes (2-3 day delay). Requires yt-analytics.readonly scope (re-authorization may be needed).

Parameters:

video_id (String) —
The YouTube video ID (e.g., "dQw4w9WgXcQ")
account_id (String) —
The Zernio account ID for the YouTube account
opts (Hash) (defaults to: {}) —
the optional parameters

Options Hash (opts):

:start_date (Date) —
Start date (YYYY-MM-DD). Defaults to the video's publish date (lifetime curve).
:end_date (Date) —
End date (YYYY-MM-DD). Defaults to 3 days ago (YouTube data latency).

Returns:

(Array<(YouTubeVideoRetentionResponse, Integer, Hash)>) —
YouTubeVideoRetentionResponse data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1781

def get_you_tube_video_retention_with_http_info(video_id, account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.get_you_tube_video_retention ...'
  end
  # verify the required parameter 'video_id' is set
  if @api_client.config.client_side_validation && video_id.nil?
    fail ArgumentError, "Missing the required parameter 'video_id' when calling AnalyticsApi.get_you_tube_video_retention"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AnalyticsApi.get_you_tube_video_retention"
  end
  # resource path
  local_var_path = '/v1/analytics/youtube/video-retention'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'videoId'] = video_id
  query_params[:'accountId'] = account_id
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'YouTubeVideoRetentionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.get_you_tube_video_retention",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#get_you_tube_video_retention\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_external_posts(sync_external_posts_request, opts = {}) ⇒ `SyncExternalPosts200Response`

Sync an external post Fetch an account's latest external posts (published directly on the platform, not through Zernio) on demand, so a just-published post is retrievable within seconds instead of waiting for the background sync (which refreshes each account at most every ~90 minutes). Primary use case: verifying a submitted post. When a user publishes on the platform and immediately pastes the post URL into your app, call this with accountId plus url (or postId) to confirm the post exists and return its metadata. Behavior: - We check our stored copy first and return immediately if the post is already known (no platform call). - Otherwise we fetch the account's latest posts live from the platform, then match and return the submitted post. - Requests are debounced per account (~15s): if the account was just synced, the live fetch is skipped. accountId is required — a post URL or id alone cannot be resolved to an account, and the account must be connected to Zernio (we use its token to read the platform). Supported for every platform with a listing API (Instagram, Facebook, TikTok, YouTube, X, Threads, Pinterest, Reddit, Bluesky, Google Business, and LinkedIn organization accounts; LinkedIn personal accounts are not supported). url accepts any format the platform uses (e.g. instagram.com/p/…, instagram.com/reel/…, youtu.be/…, youtube.com/shorts/…, tiktok.com/@user/video/…, and vm.tiktok.com short links). Pass postId (the platform media/video id) as an alternative locator. Note: post-level analytics (reach, impressions) still carry the platform's own delay (e.g. ~24h on Instagram). This endpoint confirms the post exists and returns its metadata plus basic engagement (likes, comments), not delayed insights.

Parameters:

sync_external_posts_request (SyncExternalPostsRequest)
opts (Hash) (defaults to: {}) —
the optional parameters

Returns:

(SyncExternalPosts200Response)

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1842

def sync_external_posts(sync_external_posts_request, opts = {})
  data, _status_code, _headers = sync_external_posts_with_http_info(sync_external_posts_request, opts)
  data
end

#sync_external_posts_with_http_info(sync_external_posts_request, opts = {}) ⇒ `Array<(SyncExternalPosts200Response, Integer, Hash)>`

Sync an external post Fetch an account's latest external posts (published directly on the platform, not through Zernio) on demand, so a just-published post is retrievable within seconds instead of waiting for the background sync (which refreshes each account at most every ~90 minutes). Primary use case: verifying a submitted post. When a user publishes on the platform and immediately pastes the post URL into your app, call this with `accountId` plus `url` (or `postId`) to confirm the post exists and return its metadata. Behavior: - We check our stored copy first and return immediately if the post is already known (no platform call). - Otherwise we fetch the account's latest posts live from the platform, then match and return the submitted post. - Requests are debounced per account (~15s): if the account was just synced, the live fetch is skipped. `accountId` is required — a post URL or id alone cannot be resolved to an account, and the account must be connected to Zernio (we use its token to read the platform). Supported for every platform with a listing API (Instagram, Facebook, TikTok, YouTube, X, Threads, Pinterest, Reddit, Bluesky, Google Business, and LinkedIn organization accounts; LinkedIn personal accounts are not supported). `url` accepts any format the platform uses (e.g. `instagram.com/p/…`, `instagram.com/reel/…`, `youtu.be/…`, `youtube.com/shorts/…`, `tiktok.com/@user/video/…`, and `vm.tiktok.com` short links). Pass `postId` (the platform media/video id) as an alternative locator. Note: post-level analytics (reach, impressions) still carry the platform's own delay (e.g. ~24h on Instagram). This endpoint confirms the post exists and returns its metadata plus basic engagement (likes, comments), not delayed insights.

Parameters:

sync_external_posts_request (SyncExternalPostsRequest)
opts (Hash) (defaults to: {}) —
the optional parameters

Returns:

(Array<(SyncExternalPosts200Response, Integer, Hash)>) —
SyncExternalPosts200Response data, response status code and response headers

# File 'lib/zernio-sdk/api/analytics_api.rb', line 1852

def sync_external_posts_with_http_info(sync_external_posts_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalyticsApi.sync_external_posts ...'
  end
  # verify the required parameter 'sync_external_posts_request' is set
  if @api_client.config.client_side_validation && sync_external_posts_request.nil?
    fail ArgumentError, "Missing the required parameter 'sync_external_posts_request' when calling AnalyticsApi.sync_external_posts"
  end
  # resource path
  local_var_path = '/v1/posts/sync-external'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(sync_external_posts_request)

  # return_type
  return_type = opts[:debug_return_type] || 'SyncExternalPosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"AnalyticsApi.sync_external_posts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalyticsApi#sync_external_posts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AnalyticsApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#get_analytics(opts = {}) ⇒ GetAnalytics200Response

#get_analytics_with_http_info(opts = {}) ⇒ Array<(GetAnalytics200Response, Integer, Hash)>

#get_best_time_to_post(opts = {}) ⇒ GetBestTimeToPost200Response

#get_best_time_to_post_with_http_info(opts = {}) ⇒ Array<(GetBestTimeToPost200Response, Integer, Hash)>

#get_content_decay(opts = {}) ⇒ GetContentDecay200Response

#get_content_decay_with_http_info(opts = {}) ⇒ Array<(GetContentDecay200Response, Integer, Hash)>

#get_daily_metrics(opts = {}) ⇒ GetDailyMetrics200Response

#get_daily_metrics_with_http_info(opts = {}) ⇒ Array<(GetDailyMetrics200Response, Integer, Hash)>

#get_facebook_page_insights(account_id, opts = {}) ⇒ InstagramAccountInsightsResponse

#get_facebook_page_insights_with_http_info(account_id, opts = {}) ⇒ Array<(InstagramAccountInsightsResponse, Integer, Hash)>

#get_facebook_post_reactions(account_id, post_id, opts = {}) ⇒ GetFacebookPostReactions200Response

#get_facebook_post_reactions_with_http_info(account_id, post_id, opts = {}) ⇒ Array<(GetFacebookPostReactions200Response, Integer, Hash)>

#get_follower_stats(opts = {}) ⇒ FollowerStatsResponse

#get_follower_stats_with_http_info(opts = {}) ⇒ Array<(FollowerStatsResponse, Integer, Hash)>

#get_google_business_performance(account_id, opts = {}) ⇒ GetGoogleBusinessPerformance200Response

#get_google_business_performance_with_http_info(account_id, opts = {}) ⇒ Array<(GetGoogleBusinessPerformance200Response, Integer, Hash)>

#get_google_business_search_keywords(account_id, opts = {}) ⇒ GetGoogleBusinessSearchKeywords200Response

#get_google_business_search_keywords_with_http_info(account_id, opts = {}) ⇒ Array<(GetGoogleBusinessSearchKeywords200Response, Integer, Hash)>

#get_instagram_account_insights(account_id, opts = {}) ⇒ InstagramAccountInsightsResponse

#get_instagram_account_insights_with_http_info(account_id, opts = {}) ⇒ Array<(InstagramAccountInsightsResponse, Integer, Hash)>

#get_instagram_demographics(account_id, opts = {}) ⇒ InstagramDemographicsResponse

#get_instagram_demographics_with_http_info(account_id, opts = {}) ⇒ Array<(InstagramDemographicsResponse, Integer, Hash)>

#get_instagram_follower_history(account_id, opts = {}) ⇒ InstagramAccountInsightsResponse

#get_instagram_follower_history_with_http_info(account_id, opts = {}) ⇒ Array<(InstagramAccountInsightsResponse, Integer, Hash)>

#get_linked_in_aggregate_analytics(account_id, opts = {}) ⇒ GetLinkedInAggregateAnalytics200Response

#get_linked_in_aggregate_analytics_with_http_info(account_id, opts = {}) ⇒ Array<(GetLinkedInAggregateAnalytics200Response, Integer, Hash)>

#get_linked_in_org_aggregate_analytics(account_id, opts = {}) ⇒ InstagramAccountInsightsResponse

#get_linked_in_org_aggregate_analytics_with_http_info(account_id, opts = {}) ⇒ Array<(InstagramAccountInsightsResponse, Integer, Hash)>

#get_linked_in_post_analytics(account_id, urn, opts = {}) ⇒ GetLinkedInPostAnalytics200Response

#get_linked_in_post_analytics_with_http_info(account_id, urn, opts = {}) ⇒ Array<(GetLinkedInPostAnalytics200Response, Integer, Hash)>

#get_linked_in_post_reactions(account_id, urn, opts = {}) ⇒ GetLinkedInPostReactions200Response

#get_linked_in_post_reactions_with_http_info(account_id, urn, opts = {}) ⇒ Array<(GetLinkedInPostReactions200Response, Integer, Hash)>

#get_post_timeline(post_id, opts = {}) ⇒ GetPostTimeline200Response

#get_post_timeline_with_http_info(post_id, opts = {}) ⇒ Array<(GetPostTimeline200Response, Integer, Hash)>

#get_posting_frequency(opts = {}) ⇒ GetPostingFrequency200Response

#get_posting_frequency_with_http_info(opts = {}) ⇒ Array<(GetPostingFrequency200Response, Integer, Hash)>

#get_tik_tok_account_insights(account_id, opts = {}) ⇒ InstagramAccountInsightsResponse

#get_tik_tok_account_insights_with_http_info(account_id, opts = {}) ⇒ Array<(InstagramAccountInsightsResponse, Integer, Hash)>

#get_you_tube_channel_insights(account_id, opts = {}) ⇒ InstagramAccountInsightsResponse

#get_you_tube_channel_insights_with_http_info(account_id, opts = {}) ⇒ Array<(InstagramAccountInsightsResponse, Integer, Hash)>

#get_you_tube_daily_views(video_id, account_id, opts = {}) ⇒ YouTubeDailyViewsResponse

#get_you_tube_daily_views_with_http_info(video_id, account_id, opts = {}) ⇒ Array<(YouTubeDailyViewsResponse, Integer, Hash)>

#get_you_tube_demographics(account_id, opts = {}) ⇒ YouTubeDemographicsResponse

#get_you_tube_demographics_with_http_info(account_id, opts = {}) ⇒ Array<(YouTubeDemographicsResponse, Integer, Hash)>

#get_you_tube_video_retention(video_id, account_id, opts = {}) ⇒ YouTubeVideoRetentionResponse

#get_you_tube_video_retention_with_http_info(video_id, account_id, opts = {}) ⇒ Array<(YouTubeVideoRetentionResponse, Integer, Hash)>

#sync_external_posts(sync_external_posts_request, opts = {}) ⇒ SyncExternalPosts200Response

#sync_external_posts_with_http_info(sync_external_posts_request, opts = {}) ⇒ Array<(SyncExternalPosts200Response, Integer, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `AnalyticsApi`

#api_client ⇒ `Object`

#get_analytics(opts = {}) ⇒ `GetAnalytics200Response`

#get_analytics_with_http_info(opts = {}) ⇒ `Array<(GetAnalytics200Response, Integer, Hash)>`

#get_best_time_to_post(opts = {}) ⇒ `GetBestTimeToPost200Response`

#get_best_time_to_post_with_http_info(opts = {}) ⇒ `Array<(GetBestTimeToPost200Response, Integer, Hash)>`

#get_content_decay(opts = {}) ⇒ `GetContentDecay200Response`

#get_content_decay_with_http_info(opts = {}) ⇒ `Array<(GetContentDecay200Response, Integer, Hash)>`

#get_daily_metrics(opts = {}) ⇒ `GetDailyMetrics200Response`

#get_daily_metrics_with_http_info(opts = {}) ⇒ `Array<(GetDailyMetrics200Response, Integer, Hash)>`

#get_facebook_page_insights(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

#get_facebook_page_insights_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

#get_facebook_post_reactions(account_id, post_id, opts = {}) ⇒ `GetFacebookPostReactions200Response`

#get_facebook_post_reactions_with_http_info(account_id, post_id, opts = {}) ⇒ `Array<(GetFacebookPostReactions200Response, Integer, Hash)>`

#get_follower_stats(opts = {}) ⇒ `FollowerStatsResponse`

#get_follower_stats_with_http_info(opts = {}) ⇒ `Array<(FollowerStatsResponse, Integer, Hash)>`

#get_google_business_performance(account_id, opts = {}) ⇒ `GetGoogleBusinessPerformance200Response`

#get_google_business_performance_with_http_info(account_id, opts = {}) ⇒ `Array<(GetGoogleBusinessPerformance200Response, Integer, Hash)>`

#get_google_business_search_keywords(account_id, opts = {}) ⇒ `GetGoogleBusinessSearchKeywords200Response`

#get_google_business_search_keywords_with_http_info(account_id, opts = {}) ⇒ `Array<(GetGoogleBusinessSearchKeywords200Response, Integer, Hash)>`

#get_instagram_account_insights(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

#get_instagram_account_insights_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

#get_instagram_demographics(account_id, opts = {}) ⇒ `InstagramDemographicsResponse`

#get_instagram_demographics_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramDemographicsResponse, Integer, Hash)>`

#get_instagram_follower_history(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

#get_instagram_follower_history_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

#get_linked_in_aggregate_analytics(account_id, opts = {}) ⇒ `GetLinkedInAggregateAnalytics200Response`

#get_linked_in_aggregate_analytics_with_http_info(account_id, opts = {}) ⇒ `Array<(GetLinkedInAggregateAnalytics200Response, Integer, Hash)>`

#get_linked_in_org_aggregate_analytics(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

#get_linked_in_org_aggregate_analytics_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

#get_linked_in_post_analytics(account_id, urn, opts = {}) ⇒ `GetLinkedInPostAnalytics200Response`

#get_linked_in_post_analytics_with_http_info(account_id, urn, opts = {}) ⇒ `Array<(GetLinkedInPostAnalytics200Response, Integer, Hash)>`

#get_linked_in_post_reactions(account_id, urn, opts = {}) ⇒ `GetLinkedInPostReactions200Response`

#get_linked_in_post_reactions_with_http_info(account_id, urn, opts = {}) ⇒ `Array<(GetLinkedInPostReactions200Response, Integer, Hash)>`

#get_post_timeline(post_id, opts = {}) ⇒ `GetPostTimeline200Response`

#get_post_timeline_with_http_info(post_id, opts = {}) ⇒ `Array<(GetPostTimeline200Response, Integer, Hash)>`

#get_posting_frequency(opts = {}) ⇒ `GetPostingFrequency200Response`

#get_posting_frequency_with_http_info(opts = {}) ⇒ `Array<(GetPostingFrequency200Response, Integer, Hash)>`

#get_tik_tok_account_insights(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

#get_tik_tok_account_insights_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

#get_you_tube_channel_insights(account_id, opts = {}) ⇒ `InstagramAccountInsightsResponse`

#get_you_tube_channel_insights_with_http_info(account_id, opts = {}) ⇒ `Array<(InstagramAccountInsightsResponse, Integer, Hash)>`

#get_you_tube_daily_views(video_id, account_id, opts = {}) ⇒ `YouTubeDailyViewsResponse`

#get_you_tube_daily_views_with_http_info(video_id, account_id, opts = {}) ⇒ `Array<(YouTubeDailyViewsResponse, Integer, Hash)>`

#get_you_tube_demographics(account_id, opts = {}) ⇒ `YouTubeDemographicsResponse`

#get_you_tube_demographics_with_http_info(account_id, opts = {}) ⇒ `Array<(YouTubeDemographicsResponse, Integer, Hash)>`

#get_you_tube_video_retention(video_id, account_id, opts = {}) ⇒ `YouTubeVideoRetentionResponse`

#get_you_tube_video_retention_with_http_info(video_id, account_id, opts = {}) ⇒ `Array<(YouTubeVideoRetentionResponse, Integer, Hash)>`

#sync_external_posts(sync_external_posts_request, opts = {}) ⇒ `SyncExternalPosts200Response`

#sync_external_posts_with_http_info(sync_external_posts_request, opts = {}) ⇒ `Array<(SyncExternalPosts200Response, Integer, Hash)>`