Module: Slack::Web::Api::Endpoints::AdminAnalytics

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/admin_analytics.rb

Instance Method Summary collapse

Instance Method Details

#admin_analytics_getFile(options = {}) ⇒ Object

Retrieve analytics data for a given date, presented as a compressed JSON file

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :type (Object)

    The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).

  • :date (Object)

    Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.

  • :metadata_only (Object)

    Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.

See Also:



20
21
22
23
# File 'lib/slack/web/api/endpoints/admin_analytics.rb', line 20

def admin_analytics_getFile(options = {})
  throw ArgumentError.new('Required arguments :type missing') if options[:type].nil?
  post('admin.analytics.getFile', options)
end