Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods admin.analytics.messages.activity.json
Raw

priv/docs/methods/admin.analytics.messages.activity.json

{
"args": {
"channel": {
"desc": "Channel ID for channel of the message activity to query.",
"required": true,
"type": "string"
},
"cursor": {
"desc": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection.",
"example": "abcd...",
"required": false,
"type": "string"
},
"latest_ts": {
"desc": "Most recent timestamp to include in results. Defaults to current time. If not passed while still passing the `oldest_ts` parameter, defaults to 7 days after `oldest_ts`.",
"required": false,
"type": "string"
},
"limit": {
"default": "50",
"desc": "Maximum number of entries to return. The maximum limit is 100.",
"required": false,
"type": "integer"
},
"oldest_ts": {
"desc": "Oldest timestamp to include in the results. Defaults to 7 days before current time. If not passed while still passing the `latest_ts` parameter, defaults to 7 days before `latest_ts`.",
"required": false,
"type": "string"
}
},
"desc": "Retrieves activity metrics for messages from a given channel.",
"errors": {
"channel_not_found": "The specified channel was not found.",
"not_an_enterprise": "The user token does not belong to an enterprise.",
"restricted_action": "The token does not have permission to access this resource.",
"restricted_plan_level": "The enterprise plan level does not have access to this feature."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"user": [
{
"name": "admin.analytics:read",
"url": "https://docs.slack.dev/reference/scopes/admin.analytics.read"
}
]
}
}