Skip to main content
GET
/
api
/
admins
/
coding
/
slack
cURL
curl --request GET \
  --url https://recoup-api.vercel.app/api/admins/coding/slack \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "total": 134,
  "total_pull_requests": 121,
  "tags_with_pull_requests": 84,
  "tags": [
    {
      "user_id": "U012AB3CD",
      "user_name": "Jane Smith",
      "prompt": "add dark mode support to the settings page",
      "timestamp": "2024-01-15T10:30:00.000Z",
      "channel_id": "C012AB3CD",
      "channel_name": "dev-team",
      "user_avatar": "https://avatars.slack-edge.com/...",
      "pull_requests": [
        "https://github.com/recoupable/api/pull/42"
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Query Parameters

​
period
enum<string>
default:all

Time period to filter tags. One of: all (no date filter), daily (last 24 hours), weekly (last 7 days), monthly (last 30 days). Defaults to all.

Available options:
all,
daily,
weekly,
monthly

Response

Slack tag analytics retrieved successfully

​
status
enum<string>
required

Status of the request

Available options:
success
​
total
integer
required

Total number of times the Coding Agent was tagged in the requested period

Example:

134

​
total_pull_requests
integer
required

Total number of pull requests opened by the Coding Agent across all tags in the requested period

Example:

121

​
tags_with_pull_requests
integer
required

Number of tags that resulted in at least one pull request being opened

Example:

84

​
tags
object[]
required

List of Slack tag events