{ "opencollection": "1.0.0", "info": { "name": "CircleCI REST API v1 Artifact Insights API", "version": "1.1" }, "request": { "auth": { "type": "apikey", "key": "Circle-Token", "value": "{{Circle-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Insights", "type": "folder" }, "items": [ { "info": { "name": "Get project workflow metrics", "type": "http" }, "http": { "method": "GET", "url": "https://circleci.com/api/v1.1/insights/:project-slug/workflows", "params": [ { "name": "project-slug", "value": "", "type": "path", "description": "The project slug in the form vcs-slug/org-name/repo-name (e.g., gh/CircleCI-Public/api-preview-docs)" }, { "name": "branch", "value": "", "type": "query", "description": "Filter by branch name" }, { "name": "reporting-window", "value": "", "type": "query", "description": "The time window for metrics" }, { "name": "page-token", "value": "", "type": "query", "description": "Token for retrieving the next page of results" } ] }, "docs": "Returns summary metrics for the workflows of a given project, including success rates, duration metrics, and throughput." }, { "info": { "name": "Get recent runs of a workflow", "type": "http" }, "http": { "method": "GET", "url": "https://circleci.com/api/v1.1/insights/:project-slug/workflows/:workflow-name", "params": [ { "name": "project-slug", "value": "", "type": "path", "description": "The project slug in the form vcs-slug/org-name/repo-name (e.g., gh/CircleCI-Public/api-preview-docs)" }, { "name": "workflow-name", "value": "", "type": "path", "description": "The name of the workflow" }, { "name": "branch", "value": "", "type": "query", "description": "Filter by branch name" }, { "name": "page-token", "value": "", "type": "query", "description": "Token for retrieving the next page of results" } ] }, "docs": "Returns recent runs of a named workflow, containing status, duration, and credits consumed." }, { "info": { "name": "Get workflow job metrics", "type": "http" }, "http": { "method": "GET", "url": "https://circleci.com/api/v1.1/insights/:project-slug/workflows/:workflow-name/jobs", "params": [ { "name": "project-slug", "value": "", "type": "path", "description": "The project slug in the form vcs-slug/org-name/repo-name (e.g., gh/CircleCI-Public/api-preview-docs)" }, { "name": "workflow-name", "value": "", "type": "path", "description": "The name of the workflow" }, { "name": "branch", "value": "", "type": "query", "description": "Filter by branch name" }, { "name": "reporting-window", "value": "", "type": "query", "description": "The time window for metrics" }, { "name": "page-token", "value": "", "type": "query", "description": "Token for retrieving the next page of results" } ] }, "docs": "Returns summary metrics for the jobs within a named workflow, including success rates and duration metrics." }, { "info": { "name": "Get test metrics for a workflow", "type": "http" }, "http": { "method": "GET", "url": "https://circleci.com/api/v1.1/insights/:project-slug/workflows/:workflow-name/test-metrics", "params": [ { "name": "project-slug", "value": "", "type": "path", "description": "The project slug in the form vcs-slug/org-name/repo-name (e.g., gh/CircleCI-Public/api-preview-docs)" }, { "name": "workflow-name", "value": "", "type": "path", "description": "The name of the workflow" } ] }, "docs": "Returns test metrics for a named workflow, including most frequently failing tests and slowest tests." } ] } ], "bundled": true }