Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-04-06 18:09:23 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-04-06 18:09:23 +0300
commit2e1b10493f9ed9685eb892ab747335983e58f154 (patch)
treef5d4cbee99cd3aec51e90e1725d95616d3d07859 /doc/api/usage_data.md
parentebed39e3cedad74e1a1ee4e8d33adfb8bbdc7040 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/usage_data.md')
-rw-r--r--doc/api/usage_data.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/api/usage_data.md b/doc/api/usage_data.md
new file mode 100644
index 00000000000..f54a0808d51
--- /dev/null
+++ b/doc/api/usage_data.md
@@ -0,0 +1,68 @@
+---
+stage: Growth
+group: Product Intelligence
+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
+type: reference, api
+---
+
+# UsageData 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.
+
+## UsageDataQueries API
+
+> - [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.
+
+Example request:
+
+```shell
+curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/usage_data/queries
+```
+
+Sample response
+
+```json
+{
+ "recorded_at": "2021-03-23T06:31:21.267Z",
+ "uuid": null,
+ "hostname": "localhost",
+ "version": "13.11.0-pre",
+ "installation_type": "gitlab-development-kit",
+ "active_user_count": "SELECT COUNT(\"users\".\"id\") FROM \"users\" WHERE (\"users\".\"state\" IN ('active')) AND (\"users\".\"user_type\" IS NULL OR \"users\".\"user_type\" IN (NULL, 6, 4))",
+ "edition": "EE",
+ "license_md5": "c701acc03844c45366dd175ef7a4e19c",
+ "license_id": null,
+ "historical_max_users": 0,
+ "licensee": {
+ "Name": "John Doe1"
+ },
+ "license_user_count": null,
+ "license_starts_at": "1970-01-01",
+ "license_expires_at": "2022-02-23",
+ "license_plan": "starter",
+ "license_add_ons": {
+ "GitLab_FileLocks": 1,
+ "GitLab_Auditor_User": 1
+ },
+ "license_trial": null,
+ "license_subscription_id": "0000",
+ "license": {},
+ "settings": {
+ "ldap_encrypted_secrets_enabled": false,
+ "operating_system": "mac_os_x-11.2.2"
+ },
+ "counts": {
+ "assignee_lists": "SELECT COUNT(\"lists\".\"id\") FROM \"lists\" WHERE \"lists\".\"list_type\" = 3",
+ "boards": "SELECT COUNT(\"boards\".\"id\") FROM \"boards\"",
+ "ci_builds": "SELECT COUNT(\"ci_builds\".\"id\") FROM \"ci_builds\" WHERE \"ci_builds\".\"type\" = 'Ci::Build'",
+ "ci_internal_pipelines": "SELECT COUNT(\"ci_pipelines\".\"id\") FROM \"ci_pipelines\" WHERE (\"ci_pipelines\".\"source\" IN (1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13) OR \"ci_pipelines\".\"source\" IS NULL)",
+ "ci_external_pipelines": "SELECT COUNT(\"ci_pipelines\".\"id\") FROM \"ci_pipelines\" WHERE \"ci_pipelines\".\"source\" = 6",
+ "ci_pipeline_config_auto_devops": "SELECT COUNT(\"ci_pipelines\".\"id\") FROM \"ci_pipelines\" WHERE \"ci_pipelines\".\"config_source\" = 2",
+ "ci_pipeline_config_repository": "SELECT COUNT(\"ci_pipelines\".\"id\") FROM \"ci_pipelines\" WHERE \"ci_pipelines\".\"config_source\" = 1",
+ "ci_runners": "SELECT COUNT(\"ci_runners\".\"id\") FROM \"ci_runners\"",
+...
+```