diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-15 18:09:11 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-04-15 18:09:11 +0300 |
commit | 10130901f1128c91596c4cbfe14b1e5c9f15032f (patch) | |
tree | 18051a0297d9af135e4546689a91b9033bae6f59 /doc/api/usage_data.md | |
parent | 69b0ff9002af73de066a6f28e4a61ccf1fddd9a7 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/usage_data.md')
-rw-r--r-- | doc/api/usage_data.md | 56 |
1 files changed, 50 insertions, 6 deletions
diff --git a/doc/api/usage_data.md b/doc/api/usage_data.md index 671e60be587..024caa96565 100644 --- a/doc/api/usage_data.md +++ b/doc/api/usage_data.md @@ -5,17 +5,61 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference, api --- -# UsageData API **(FREE SELF)** +# Usage Data API **(FREE SELF)** -The UsageData API, associated with [Usage Ping](../development/usage_ping/index.md), is available only for -the use of GitLab instance [Administrator](../user/permissions.md) users. +The Usage Data API is associated with [Usage Ping](../development/usage_ping/index.md). -## UsageDataQueries API +## Export metric definitions as a single YAML file + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57270) in GitLab 13.11. + +Export all metric definitions as a single YAML file, similar to the [Metrics Dictionary](../development/usage_ping/dictionary.md), for easier importing. + +```plaintext +GET /usage_data/metric_definitions +``` + +Example request: + +```shell +curl "https://gitlab.example.com/api/v4/usage_data/metric_definitions" +``` + +Example response: + +```yaml +--- +- key_path: redis_hll_counters.search.i_search_paid_monthly + description: Calculated unique users to perform a search with a paid license enabled + by month + product_section: enablement + product_stage: enablement + product_group: group::global search + product_category: global_search + value_type: number + status: data_available + time_frame: 28d + data_source: redis_hll + distribution: + - ee + tier: + - premium + - ultimate +... +``` + +## Export Usage Ping SQL queries + +This action is available only for the GitLab instance [Administrator](../user/permissions.md) users. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57016) in GitLab 13.11. > - [Deployed behind a feature flag](../user/feature_flags.md), disabled by default. -Return all of the raw SQL queries used to compute usage ping. +Return all of the raw SQL queries used to compute Usage Ping. + +```plaintext +GET /usage_data/queries +``` Example request: @@ -23,7 +67,7 @@ Example request: curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/usage_data/queries" ``` -Sample response +Example response: ```json { |