debian-mirror-gitlab/doc/api/group_activity_analytics.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

82 lines
1.8 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
stage: Manage
group: Optimize
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2021-11-11 11:23:49 +05:30
# Group Activity Analytics API **(PREMIUM)**
2020-04-08 14:13:33 +05:30
2020-10-24 23:57:45 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26460) in GitLab 12.9.
2020-04-08 14:13:33 +05:30
## Get count of recently created issues for group
```plaintext
GET /analytics/group_activity/issues_count
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `group_path` | string | yes | Group path |
Example request:
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/analytics/group_activity/issues_count?group_path=gitlab-org"
2020-04-08 14:13:33 +05:30
```
Example response:
```json
2020-04-22 19:07:51 +05:30
{ "issues_count": 10 }
2020-04-08 14:13:33 +05:30
```
## Get count of recently created merge requests for group
```plaintext
GET /analytics/group_activity/merge_requests_count
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `group_path` | string | yes | Group path |
Example request:
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/analytics/group_activity/merge_requests_count?group_path=gitlab-org"
2020-04-08 14:13:33 +05:30
```
Example response:
```json
2020-04-22 19:07:51 +05:30
{ "merge_requests_count": 10 }
```
## Get count of members recently added to group
```plaintext
GET /analytics/group_activity/new_members_count
```
Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `group_path` | string | yes | Group path |
Example request:
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/analytics/group_activity/new_members_count?group_path=gitlab-org"
2020-04-22 19:07:51 +05:30
```
Example response:
```json
{ "new_members_count": 10 }
2020-04-08 14:13:33 +05:30
```