Get summary metrics for a project workflow's jobs.
GET {{baseUrl}}/insights/:project-slug/workflows/:workflow-name/jobs?page-token=consequat est&all-branches=true&branch=consequat est&reporting-window=last-90-days
Get summary metrics for a project workflow's jobs. Job 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 real time financial reporting tool and should not be used for credit reporting. The most up to date credit information can be found in Plan Overview in the CircleCI UI.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page-token | string | A token to retrieve the next page of results. | |
all-branches | boolean | Whether to retrieve data for all branches combined. Use either this parameter OR the branch name parameter. | |
branch | string | The name of a vcs branch. If not passed we will scope the API call to the default branch. | |
reporting-window | string | The time window used to calculate summary metrics. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"name":"velit deserunt ut","window_start":"1965-06-28T11:51:45.793Z","window_end":"1949-01-29T07:44:13.547Z","metrics":{"success_rate":-91775741.4043467,"total_runs":75040478,"failed_runs":54220872,"successful_runs":21375485,"throughput":-34211929.820471056,"total_credits_used":75781862,"duration_metrics":{"min":58405186,"mean":30107548,"median":88886994,"p95":55705659,"max":18115223,"standard_deviation":16429942.515398905}}},{"name":"enim laboris velit","window_start":"2016-08-26T16:06:51.683Z","window_end":"1965-06-29T23:17:18.059Z","metrics":{"success_rate":-12788513.670854673,"total_runs":84385256,"failed_runs":41899048,"successful_runs":5490358,"throughput":71610056.70642316,"total_credits_used":38326233,"duration_metrics":{"min":27456187,"mean":59110778,"median":37273988,"p95":65654412,"max":70123131,"standard_deviation":50201579.67022282}}}],"next_page_token":"nisi ea occaecat cupidatat"}