Skip to content

Commit 1ff41c0

Browse files
dblockdblock
committed
Output from rake api:ref:download.
1 parent b501250 commit 1ff41c0

File tree

298 files changed

+39084
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

298 files changed

+39084
-0
lines changed

‎docs.slack.dev/events/events.json‎

Lines changed: 1999 additions & 0 deletions
Large diffs are not rendered by default.

‎docs.slack.dev/methods/admin.analytics.getFile.json‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
{
2+
"desc": "Retrieve analytics data for a given date, presented as a compressed JSON file",
3+
"http_method": "POST",
4+
"scope": "admin.analytics:read",
5+
"rate_limits": "t2",
6+
"args": {
7+
"type": "object",
8+
"required": [
9+
"token",
10+
"type"
11+
],
12+
"properties": {
13+
"token": {
14+
"type": "string",
15+
"desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.",
16+
"subtype": "auth",
17+
"example": "xxxx-xxxxxxxxx-xxxx"
18+
},
19+
"date": {
20+
"desc": "Date to retrieve the analytics data for, expressed as `YYYY-MM-DD` in UTC. Required unless `metadata_only` is set to true.",
21+
"example": "2020-09-01",
22+
"schema": "date"
23+
},
24+
"type": {
25+
"desc": "The type of analytics to retrieve. The options are currently limited to `member` (for Enterprise org member analytics) and `public_channel` (for public channel analytics).",
26+
"type": "string",
27+
"example": "member"
28+
},
29+
"metadata_only": {
30+
"desc": "Retrieve metadata for the `type` of analytics indicated. Can be used only with `type` set to `public_channel` analytics. See [detail below](#metadata_only). Omit the `date` parameter when using this argument.",
31+
"type": "boolean",
32+
"example": "true",
33+
"default": "false"
34+
}
35+
}
36+
},
37+
"output": null,
38+
"errors": {
39+
"data_not_available": {
40+
"desc": "The `date` was before the API became available."
41+
},
42+
"feature_not_available": {
43+
"desc": "The user token does not belong to an Enterprise or Business+ team."
44+
},
45+
"feature_not_enabled": {
46+
"desc": "This feature is not enabled on your workspace."
47+
},
48+
"file_not_found": {
49+
"desc": "The analytics data for the `date` specified weren't found."
50+
},
51+
"file_not_yet_available": {
52+
"desc": "The analytics data for the `date` isn't available yet."
53+
},
54+
"invalid_arguments": {
55+
"desc": "Arguments weren't fully provided. For example, the `date` argument wasn't passed."
56+
},
57+
"invalid_date": {
58+
"desc": "The `date` argument was invalid."
59+
},
60+
"invalid_type": {
61+
"desc": "The analytics data for the `type` specified weren't found."
62+
},
63+
"member_analytics_disabled": {
64+
"desc": "Member analytics are disabled for your organization."
65+
},
66+
"metadata_not_available": {
67+
"desc": "Metadata not available for the analytics `type` you provided."
68+
},
69+
"metadata_only_does_not_support_date": {
70+
"desc": "The `metadata_only` field gets the latest metadata file. The `date` field is not supported."
71+
},
72+
"missing_scope": {
73+
"desc": "This token doesn't have the scope required."
74+
},
75+
"not_an_admin": {
76+
"desc": "The user token does not have admin privileges."
77+
},
78+
"org_level_email_display_disabled": {
79+
"desc": "This API is unavailable for organizations with a _'Hide email addresses'_ policy."
80+
},
81+
"user_cannot_manage_public_channels": {
82+
"desc": "The user must have permissions to manage public channels at the Enterprise level."
83+
}
84+
},
85+
"examples": {
86+
"success": {
87+
"url": "/api/admin.analytics.getFile?token=YOUR_TOKEN&date=2020-08-01&type=member",
88+
"description": "A gzipped new-line delimited JSON file presented with a `Content-type: application/gzip` HTTP header. An example file name is `Slack Corp Member Analytics 2020-08-01.json.gz`",
89+
"example": ""
90+
},
91+
"error": {
92+
"url": "/api/admin.analytics.getFile?token=INVALID_TOKEN&date=2020-08-01&type=member",
93+
"description": "Typical Web API error response is a JSON response with a `Content-type: application/json` HTTP header.",
94+
"example": {
95+
"ok": false,
96+
"error": "org_level_email_display_disabled"
97+
}
98+
}
99+
}
100+
}

‎docs.slack.dev/methods/admin.apps.activities.list.json‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
{
2+
"desc": "Get logs for a specified team/org",
3+
"http_method": "POST",
4+
"scope": "read",
5+
"scope_by_token_type": {
6+
"oauth": "admin.app_activities:read"
7+
},
8+
"json_input_supported": false,
9+
"slack_connect_workspaces_allowed": true,
10+
"rate_limits": "t3",
11+
"args": {
12+
"type": "object",
13+
"required": [
14+
"token"
15+
],
16+
"properties": {
17+
"token": {
18+
"type": "string",
19+
"subtype": "auth",
20+
"desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.",
21+
"example": "xxxx-xxxxxxxxx-xxxx"
22+
},
23+
"app_id": {
24+
"example": "A12345",
25+
"desc": "The ID of the app to get activities from.",
26+
"schema": "app_id"
27+
},
28+
"team_id": {
29+
"type": "string",
30+
"example": "T12345",
31+
"desc": "The team who owns this log."
32+
},
33+
"cursor": {
34+
"desc": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. See [pagination](/apis/web-api/pagination) for more detail.",
35+
"example": "bG9nX2lkOjc5NjQ1NA==",
36+
"type": "string"
37+
},
38+
"limit": {
39+
"desc": "The maximum number of items to return.",
40+
"example": "100",
41+
"type": "integer"
42+
},
43+
"min_log_level": {
44+
"desc": "The minimum log level of the log events to be returned. Defaults to `info`. Acceptable values (in order of relative importance from smallest to largest) are `trace`, `debug`, `info`, `warn`, `error` and `fatal`.",
45+
"example": "info",
46+
"type": "string"
47+
},
48+
"log_event_type": {
49+
"desc": "The event type of log events to be returned.",
50+
"example": "test_log_event",
51+
"type": "string"
52+
},
53+
"source": {
54+
"desc": "The source of log events to be returned. Acceptable values are `slack` and `developer`.",
55+
"example": "slack",
56+
"type": "string"
57+
},
58+
"component_type": {
59+
"desc": "The component type of log events to be returned. Acceptable values are `events_api`, `workflows`, `functions` and `tables`.",
60+
"example": "workflows",
61+
"type": "string"
62+
},
63+
"component_id": {
64+
"desc": "The component ID of log events to be returned. Will be `FnXXXXXX` for functions, and `WfXXXXXX` for workflows",
65+
"example": "Wf013SMGL4V9",
66+
"type": "string"
67+
},
68+
"trace_id": {
69+
"desc": "The trace ID of log events to be returned.",
70+
"example": "Tr432f2",
71+
"type": "string"
72+
},
73+
"min_date_created": {
74+
"desc": "The earliest timestamp of the log to retrieve (epoch microseconds).",
75+
"example": "1646665572336251",
76+
"type": "integer"
77+
},
78+
"max_date_created": {
79+
"desc": "The latest timestamp of the log to retrieve (epoch microseconds).",
80+
"example": "1646665572336299",
81+
"type": "integer"
82+
},
83+
"sort_direction": {
84+
"desc": "The direction you want the data sorted by (always by timestamp)",
85+
"type": "string",
86+
"example": "asc",
87+
"enum": [
88+
"asc",
89+
"desc"
90+
]
91+
}
92+
}
93+
},
94+
"output": {
95+
"type": "object",
96+
"required": [
97+
"activities"
98+
],
99+
"properties": {
100+
"activities": {
101+
"items": {
102+
"schema": "activity"
103+
},
104+
"type": "array"
105+
},
106+
"response_metadata": {
107+
"type": "object",
108+
"required": [
109+
"next_cursor"
110+
],
111+
"properties": {
112+
"next_cursor": {
113+
"type": "string"
114+
}
115+
}
116+
}
117+
}
118+
},
119+
"errors": {
120+
"internal_error": {
121+
"desc": "Something went wrong on our end, please try again."
122+
},
123+
"invalid_app_id": {
124+
"desc": "App ID provided is not valid."
125+
},
126+
"invalid_app": {
127+
"desc": "App ID provided is not valid for team and user."
128+
},
129+
"invalid_args": {
130+
"desc": "Required arguments either were not provided or contain invalid values."
131+
},
132+
"invalid_cursor": {
133+
"desc": "Value passed for `cursor` was not valid or is no longer valid."
134+
},
135+
"invalid_team": {
136+
"desc": "Team ID provided is not valid"
137+
}
138+
},
139+
"examples": {
140+
"success": {
141+
"url": "/api/admin.apps.activities.list",
142+
"description": "Typical success response",
143+
"example": {
144+
"ok": true,
145+
"activities": [
146+
{
147+
"app_id": "A123456789",
148+
"level": "info",
149+
"event_type": "function_execution_started",
150+
"source": "slack",
151+
"component_type": "functions",
152+
"component_id": "Fn123",
153+
"payload": {
154+
"function_name": "Reverse",
155+
"function_type": "app"
156+
},
157+
"created": 1650463798824317,
158+
"trace_id": "Tr123"
159+
}
160+
],
161+
"response_metadata": {
162+
"next_cursor": ""
163+
}
164+
}
165+
}
166+
}
167+
}

‎docs.slack.dev/methods/admin.apps.approve.json‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
{
2+
"desc": "Approve an app for installation on a workspace.",
3+
"http_method": "POST",
4+
"scope": "admin.apps:write",
5+
"json_input_supported": true,
6+
"rate_limits": "t2",
7+
"args": {
8+
"type": "object",
9+
"required": [
10+
"token"
11+
],
12+
"properties": {
13+
"token": {
14+
"type": "string",
15+
"subtype": "auth",
16+
"desc": "Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.",
17+
"example": "xxxx-xxxxxxxxx-xxxx"
18+
},
19+
"app_id": {
20+
"desc": "The id of the app to approve.",
21+
"example": "A12345",
22+
"type": "string"
23+
},
24+
"request_id": {
25+
"desc": "The id of the request to approve.",
26+
"example": "Ar12345",
27+
"type": "string"
28+
},
29+
"team_id": {
30+
"desc": "The ID of the workspace to approve the app on",
31+
"example": "T12345",
32+
"schema": "team_id"
33+
},
34+
"enterprise_id": {
35+
"desc": "The ID of the enterprise to approve the app on",
36+
"example": "E12345",
37+
"schema": "enterprise_id"
38+
}
39+
}
40+
},
41+
"output": null,
42+
"errors": {
43+
"app_management_app_not_installed_on_org": {
44+
"desc": "The app management app must be installed on the org."
45+
},
46+
"app_restricted_org_wide": {
47+
"desc": "The app is already restricted org wide."
48+
},
49+
"custom_integration_not_allowed_at_enterprise": {
50+
"desc": "Returned when the install request is for custom integration app."
51+
},
52+
"feature_not_enabled": {
53+
"desc": "Returned when the Admin APIs feature is not enabled for this team"
54+
},
55+
"invalid_request_id": {
56+
"desc": "The `request_id` passed is invalid."
57+
},
58+
"invalid_app_id": {
59+
"desc": "The `app_id` passed is invalid."
60+
},
61+
"org_resolution_required": {
62+
"desc": "The `team_id` is in an Enterprise org while `app_id` is certified."
63+
},
64+
"invalid_scopes": {
65+
"desc": "Some of the provided scopes do not exist"
66+
},
67+
"not_an_admin": {
68+
"desc": "This method is only accessible by org owners and admins"
69+
},
70+
"request_already_resolved": {
71+
"desc": "The app request has already been resolved"
72+
},
73+
"request_id_or_app_id_is_required": {
74+
"desc": "Must include a `request_id` or `app_id`"
75+
},
76+
"request_id_required_for_custom_integrations": {
77+
"desc": "A `request_id` is required for custom integrations"
78+
},
79+
"team_not_found": {
80+
"desc": "Returned when team id is not found."
81+
},
82+
"too_many_ids_provided": {
83+
"desc": "Please provide only `app_id` OR `request_id`"
84+
},
85+
"too_many_teams_provided": {
86+
"desc": "Please provide only `team_id` OR `enterprise_id`"
87+
}
88+
}
89+
}

0 commit comments

Comments
 (0)