Get summary metrics for a project's workflows
Get summary metrics for a project's workflows. Workflow runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours. Please note that Insights is not a financial reporting tool and should not be used for precise credit reporting. Credit reporting from Insights does not use the same source of truth as the billing information that is found in the Plan Overview page in the CircleCI UI, nor does the underlying data have the same data accuracy guarantees as the billing information in the CircleCI UI. This may lead to discrepancies between credits reported from Insights and the billing information in the Plan Overview page of the CircleCI UI. For precise credit reporting, always use the Plan Overview page in the CircleCI UI.
Path parameters
Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).
Query parameters
A token to retrieve the next page of results.
Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.
The name of a vcs branch. If not passed we will scope the API call to the default branch.
The time window used to calculate summary metrics. If not provided, defaults to last-90-days
Response
A paginated list of summary metrics by workflow
Example response
{
"items": [
{
"name": "build-and-test"
}
]
}