v1

latestOpenAPI 3.0.3MIT2026-07-1411163326.7 KB
Insights

Get metrics and trends for workflows

Get the metrics and trends for a particular workflow on a single branch or all branches

get/insights/{project-slug}/workflows/{workflow-name}/summary

Path parameters

project-slugstring required

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).

workflow-namestring required

The name of the workflow.

Query parameters

all-branchesboolean

Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter.

branchstring

The name of a vcs branch. If not passed we will scope the API call to the default branch.

Response

Metrics and trends for a workflow

workflow_namesstring[] required

A list of all the workflow names for a given project.