Method: PinterestSdkClient::UserAccountApi#user_account_analytics

Defined in:

lib/pinterest_sdk/api/user_account_api.rb

#user_account_analytics(start_date, end_date, opts = {}) ⇒ Hash<String, AnalyticsMetricsResponse>

Get user account analytics Get analytics for the "operation user_account" - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".

Parameters:

• start_date (Date) —

  Metric report start date (UTC). Format: YYYY-MM-DD

• end_date (Date) —

  Metric report end date (UTC). Format: YYYY-MM-DD

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :from_claimed_content (String) —

  Filter on Pins that match your claimed domain. (default to ‘BOTH’)

• :pin_format (String) —

  Pin formats to get data for, default is all. (default to ‘ALL’)

• :app_types (String) —

  Apps or devices to get data for, default is all. (default to ‘ALL’)

• :metric_types (Array<String>) —

  Metric types to get data for, default is all.

• :split_field (String) —

  How to split the data into groups. Not including this param means data won&#39;t be split. (default to ‘NO_SPLIT’)

• :ad_account_id (String) —

  Unique identifier of an ad account.

Returns:

• (Hash<String, AnalyticsMetricsResponse>)

# File 'lib/pinterest_sdk/api/user_account_api.rb', line 34

def user_account_analytics(start_date, end_date, opts = {})
  data, _status_code, _headers = user_account_analytics_with_http_info(start_date, end_date, opts)
  data
end