gitlab-org--gitlab-foss/doc/api/project_analytics.md

1.7 KiB

stage group info type
Release Release 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 reference, api

Project Analytics API (ULTIMATE SELF)

Introduced in GitLab Ultimate 13.7.

All methods require reporter authorization.

List project deployment frequencies

Get a list of all project aliases:

GET /projects/:id/analytics/deployment_frequency?environment=:environment&from=:from&to=:to&interval=:interval
Attribute Type Required Description
id string yes The ID of the project
Parameter Type Required Description
environment string yes The name of the environment to filter by
from string yes Datetime range to start from, inclusive, ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
to string no Datetime range to end at, exclusive, ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
interval string no The bucketing interval (all, monthly, daily)
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/analytics/deployment_frequency?from=:from&to=:to&interval=:interval"

Example response:

[
  {
    "from": "2017-01-01",
    "to": "2017-01-02",
    "value": 106
  },
  {
    "from": "2017-01-02",
    "to": "2017-01-03",
    "value": 55
  }
]