Class: Onlyfans::Resources::Statistics::Reach

Inherits:

Object

• Object
• Onlyfans::Resources::Statistics::Reach

Defined in:

lib/onlyfans/resources/statistics/reach.rb

Instance Method Summary

• #get_profile_visitors(account, end_date:, start_date:, filter: nil, limit: nil, type: nil, request_options: {}) ⇒ Onlyfans::Models::Statistics::ReachGetProfileVisitorsResponse::UnionMember0, ...

  Some parameter documentations has been truncated, see Models::Statistics::ReachGetProfileVisitorsParams for more details.

• #initialize(client:) ⇒ Reach constructor private

  A new instance of Reach.

Constructor Details

#initialize(client:) ⇒ Reach

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Reach.

Parameters:

• client (Onlyfans::Client)

# File 'lib/onlyfans/resources/statistics/reach.rb', line 46

def initialize(client:)
  @client = client
end

Instance Method Details

#get_profile_visitors(account, end_date:, start_date:, filter: nil, limit: nil, type: nil, request_options: {}) ⇒ Onlyfans::Models::Statistics::ReachGetProfileVisitorsResponse::UnionMember0, ...

Some parameter documentations has been truncated, see Models::Statistics::ReachGetProfileVisitorsParams for more details.

Get the number of profile visitors for a given period.

Parameters:

• account (String) —

  The Account ID

• end_date (String) —

  The end date for the period.

• start_date (String) —

  The start date for the period

• filter (Symbol, Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::Filter, nil) —

  Optionally, filter the results by ‘chart` or `topCountries`. See example respons

• limit (Integer, nil) —

  Number of results to return

• type (Symbol, Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::Type, nil) —

  Filter all / users / guests

• request_options (Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Onlyfans::Models::Statistics::ReachGetProfileVisitorsResponse::UnionMember0, Onlyfans::Models::Statistics::ReachGetProfileVisitorsResponse::UnionMember1, Onlyfans::Models::Statistics::ReachGetProfileVisitorsResponse::UnionMember2)

See Also:

• Models::Statistics::ReachGetProfileVisitorsParams

# File 'lib/onlyfans/resources/statistics/reach.rb', line 31

def get_profile_visitors(account, params)
  parsed, options = Onlyfans::Statistics::ReachGetProfileVisitorsParams.dump_request(params)
  query = Onlyfans::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["api/%1$s/statistics/reach/profile-visitors", account],
    query: query,
    model: Onlyfans::Models::Statistics::ReachGetProfileVisitorsResponse,
    options: options
  )
end