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

• #admin_analytics_getFile(options = {}) ⇒ Object

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

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 (string) —

  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 (date) —

  Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC. Required unless metadata_only is set to true.

• :metadata_only (boolean) —

  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.

Raises:

• (ArgumentError)

See Also:

• https://api.slack.com/methods/admin.analytics.getFile
• https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.analytics/admin.analytics.getFile.json

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

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