# getPipelineSummary Retrieves pipeline execution summaries with security analysis results and metrics. ### Examples {% tabs %} {% tab title="GraphQL" %} ```graphql query GetPipelineSummary($getPipelineSummaryInput: GetPipelineSummaryInput) { getPipelineSummary(getPipelineSummaryInput: $getPipelineSummaryInput) { pipelineSummaries { apps { appId appName appType } sourceBranch targetBranch result jobId jobTriggeredBy jobTriggeredAt jobCompletedAt jobDuration jobTriggeredReason jobUrl totalIssues totalBlockingIssues pullRequestId pullRequestUrl tags { tagId tagType name displayName createdBy appliedBy tagCategory } issues { appox critical high medium low info } eventType cicdType scanCompletionStatus pipelineScanType artifactInfo { name tag digest } workflows { id name } } offset total totalFiltered } } ``` **Variables** This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. ```json { "getPipelineSummaryInput": { "limit": 100, "offset": 0, "owners": ["example"], "tagIds": ["example"], "dateRange": { "from": 1749000000000, "to": 1749900000000 }, "filters": { "apps": ["example"], "result": ["example"], "jobTriggeredBy": ["example"], "sourceBranches": ["example"], "targetBranches": ["example"], "severities": ["example"], "eventTypes": ["example"], "cicdTypes": ["example"], "tags": ["example"], "jobId": ["example"], "scanCompletionStatus": ["example"], "pipelineScanType": ["example"], "pipelineArtifactName": ["example"], "pipelineArtifactTag": ["example"], "workflows": ["example"] }, "openItems": ["digest"] } } ``` {% endtab %} {% tab title="cURL" %} ```shell curl -X POST \ https://api.cloud.ox.security/api/apollo-gateway \ -H 'Content-Type: application/json' \ -H 'Authorization: YOUR_API_TOKEN' \ -d '{ "query": "query GetPipelineSummary($getPipelineSummaryInput: GetPipelineSummaryInput) { getPipelineSummary(getPipelineSummaryInput: $getPipelineSummaryInput) { pipelineSummaries { apps { appId appName appType } sourceBranch targetBranch result jobId jobTriggeredBy jobTriggeredAt jobCompletedAt jobDuration jobTriggeredReason jobUrl totalIssues totalBlockingIssues pullRequestId pullRequestUrl tags { tagId tagType name displayName createdBy appliedBy tagCategory } issues { appox critical high medium low info } eventType cicdType scanCompletionStatus pipelineScanType artifactInfo { name tag digest } workflows { id name } } offset total totalFiltered } }", "variables": { "getPipelineSummaryInput": { "limit": 100, "offset": 0, "owners": ["example"], "tagIds": ["example"], "dateRange": { "from": 1749000000000, "to": 1749900000000 }, "filters": { "apps": ["example"], "result": ["example"], "jobTriggeredBy": ["example"], "sourceBranches": ["example"], "targetBranches": ["example"], "severities": ["example"], "eventTypes": ["example"], "cicdTypes": ["example"], "tags": ["example"], "jobId": ["example"], "scanCompletionStatus": ["example"], "pipelineScanType": ["example"], "pipelineArtifactName": ["example"], "pipelineArtifactTag": ["example"], "workflows": ["example"] }, "openItems": ["digest"] } } }' ``` {% endtab %} {% tab title="Node.js" %} ```javascript const query = 'query GetPipelineSummary($getPipelineSummaryInput: GetPipelineSummaryInput) { getPipelineSummary(getPipelineSummaryInput: $getPipelineSummaryInput) { pipelineSummaries { apps { appId appName appType } sourceBranch targetBranch result jobId jobTriggeredBy jobTriggeredAt jobCompletedAt jobDuration jobTriggeredReason jobUrl totalIssues totalBlockingIssues pullRequestId pullRequestUrl tags { tagId tagType name displayName createdBy appliedBy tagCategory } issues { appox critical high medium low info } eventType cicdType scanCompletionStatus pipelineScanType artifactInfo { name tag digest } workflows { id name } } offset total totalFiltered } }'; fetch("https://api.cloud.ox.security/api/apollo-gateway", { method: "POST", headers: { "Content-Type": "application/json", "Authorization": "YOUR_API_TOKEN" }, body: JSON.stringify({ query: query, // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. variables: { getPipelineSummaryInput: { limit: 100, offset: 0, owners: ["example"], tagIds: ["example"], dateRange: { from: 1749000000000, to: 1749900000000 }, filters: { apps: ["example"], result: ["example"], jobTriggeredBy: ["example"], sourceBranches: ["example"], targetBranches: ["example"], severities: ["example"], eventTypes: ["example"], cicdTypes: ["example"], tags: ["example"], jobId: ["example"], scanCompletionStatus: ["example"], pipelineScanType: ["example"], pipelineArtifactName: ["example"], pipelineArtifactTag: ["example"], workflows: ["example"] }, openItems: ["digest"] } } }) }) .then(response => response.json()) .then(result => console.log(JSON.stringify(result, null, 2))) .catch(error => console.error('Error:', error)); ``` {% endtab %} {% tab title="Python" %} ```python import requests query = 'query GetPipelineSummary($getPipelineSummaryInput: GetPipelineSummaryInput) { getPipelineSummary(getPipelineSummaryInput: $getPipelineSummaryInput) { pipelineSummaries { apps { appId appName appType } sourceBranch targetBranch result jobId jobTriggeredBy jobTriggeredAt jobCompletedAt jobDuration jobTriggeredReason jobUrl totalIssues totalBlockingIssues pullRequestId pullRequestUrl tags { tagId tagType name displayName createdBy appliedBy tagCategory } issues { appox critical high medium low info } eventType cicdType scanCompletionStatus pipelineScanType artifactInfo { name tag digest } workflows { id name } } offset total totalFiltered } }' response = requests.post( "https://api.cloud.ox.security/api/apollo-gateway", headers={ "Content-Type": "application/json", "Authorization": "YOUR_API_TOKEN" }, json={ "query": query, # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory. "variables": { "getPipelineSummaryInput": { "limit": 100, "offset": 0, "owners": ["example"], "tagIds": ["example"], "dateRange": { "from": 1749000000000, "to": 1749900000000 }, "filters": { "apps": ["example"], "result": ["example"], "jobTriggeredBy": ["example"], "sourceBranches": ["example"], "targetBranches": ["example"], "severities": ["example"], "eventTypes": ["example"], "cicdTypes": ["example"], "tags": ["example"], "jobId": ["example"], "scanCompletionStatus": ["example"], "pipelineScanType": ["example"], "pipelineArtifactName": ["example"], "pipelineArtifactTag": ["example"], "workflows": ["example"] }, "openItems": ["digest"] } } } ) if response.status_code == 200: result = response.json() print(result) else: print(f"Error: {response.status_code}") print(response.text) ``` {% endtab %} {% endtabs %} ### Arguments You can use the following argument(s) to customize your `getPipelineSummary` query. | Argument | Description | Supported fields | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | getPipelineSummaryInput [`GetPipelineSummaryInput`](/api-documentation/api-reference/api--pipeline/types/inputs/get-pipeline-summary-input.md) | Parameters for filtering and paginating pipeline summaries |

limit Int
offset Int
owners \[String]
tagIds \[String]
dateRange DateRange
filters PipelineSummaryFilters
openItems \[FilterTypes]

| ### Fields Return type: [`PipelineSummaryResponse`](/api-documentation/api-reference/api--pipeline/types/objects/pipeline-summary-response.md) You can use the following field(s) to specify what information your `getPipelineSummary` query will return. Please note that some fields may have their own subfields. | Field | Description | Supported fields | | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | pipelineSummaries [`[PipelineSummary]`](/api-documentation/api-reference/api--pipeline/types/objects/pipeline-summary.md) | List of pipeline execution summaries |

apps \[SingleApp]
sourceBranch String
targetBranch String
result String
jobId String
jobTriggeredBy String
jobTriggeredAt String
jobCompletedAt String
jobDuration Int
jobTriggeredReason String
jobUrl String
totalIssues String
totalBlockingIssues String
pullRequestId String
pullRequestUrl String
tags \[TagOutput]
issues IssuesBySeverity
eventType String
cicdType String
scanCompletionStatus PipelineScanCompletionStatus
pipelineScanType String
artifactInfo PipelineArtifactInfo
workflows \[OxWorkflow]

| | offset `Int` | Current pagination offset | | | total `Int` | Total number of pipeline summaries available | | | totalFiltered `Int` | Total number of pipeline summaries after applying filters | | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ox.security/api-documentation/api-reference/api--pipeline/queries/get-pipeline-summary.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.