CIcircleci
Insights

Get summary metrics with trends for the entire org, and for each project.

Gets aggregated summary metrics with trends for the entire org. Also gets aggregated metrics and trends for each project belonging to the org.

get/insights/{org-slug}/summary

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/insights/{org-slug}/summary
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Path parameters

org-slugstring required

Org slug in the form vcs-slug/org-name. The / characters may be URL-escaped.

Query parameters

reporting-window'last-7-days' | 'last-90-days' | 'last-24-hours' | 'last-30-days' | 'last-60-days'

The time window used to calculate summary metrics. If not provided, defaults to last-90-days

project-namesobject

List of project names.

Response

summary metrics with trends for an entire org and it's projects.

all_projectsstring[] required

A list of all the project names in the organization.

Example response

{
  "org_project_data": [
    {
      "project_name": "api-preview-docs"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.