Class: Vk::API::Leads::Methods::GetStats

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/leads/methods/get_stats.rb

Overview

Returns lead stats data.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Leads::Methods::GetStats

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :lead_id (Integer)

    Lead ID.

  • :secret (String)

    Secret key obtained from the lead testing interface.

  • :date_start (String)

    Day to start stats from (YYYY_MM_DD, e.g.2011-09-17).

  • :date_end (String)

    Day to finish stats (YYYY_MM_DD, e.g.2011-09-17).


# File 'lib/vk/api/leads/methods/get_stats.rb', line 15

Instance Method Details

#date_endString

Returns Day to finish stats (YYYY_MM_DD, e.g.2011-09-17).

Returns:

  • (String)

    Day to finish stats (YYYY_MM_DD, e.g.2011-09-17).


32
# File 'lib/vk/api/leads/methods/get_stats.rb', line 32

attribute :date_end, API::Types::Coercible::String.optional.default(nil)

#date_startString

Returns Day to start stats from (YYYY_MM_DD, e.g.2011-09-17).

Returns:

  • (String)

    Day to start stats from (YYYY_MM_DD, e.g.2011-09-17).


30
# File 'lib/vk/api/leads/methods/get_stats.rb', line 30

attribute :date_start, API::Types::Coercible::String.optional.default(nil)

#lead_idInteger

Returns Lead ID.

Returns:

  • (Integer)

    Lead ID.


26
# File 'lib/vk/api/leads/methods/get_stats.rb', line 26

attribute :lead_id, API::Types::Coercible::Int

#secretString

Returns Secret key obtained from the lead testing interface.

Returns:

  • (String)

    Secret key obtained from the lead testing interface.


28
# File 'lib/vk/api/leads/methods/get_stats.rb', line 28

attribute :secret, API::Types::Coercible::String.optional.default(nil)