# pipelineSummary

Comprehensive pipeline execution summary with security analysis results.

### Examples

```graphql
type PipelineSummary {
  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]
}
```

### Fields

| Field                                                                                                                                                | Description                                                             | Supported fields                                                                                                                                                                                                                    |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| apps [`[SingleApp]`](/api-documentation/api-reference/api--pipeline/types/objects/single-app.md)                                                     | Applications involved in this pipeline execution                        | <p>appId <code>String</code><br>appName <code>String</code><br>appType <code>String</code></p>                                                                                                                                      |
| sourceBranch `String`                                                                                                                                | Source branch that triggered the pipeline                               |                                                                                                                                                                                                                                     |
| targetBranch `String`                                                                                                                                | Target branch for the pipeline (usually main or master)                 |                                                                                                                                                                                                                                     |
| result `String`                                                                                                                                      | Overall result of the pipeline execution (passed, failed, blocked)      |                                                                                                                                                                                                                                     |
| jobId `String`                                                                                                                                       | Unique identifier for the pipeline job                                  |                                                                                                                                                                                                                                     |
| jobTriggeredBy `String`                                                                                                                              | User or system that triggered the pipeline job                          |                                                                                                                                                                                                                                     |
| jobTriggeredAt `String`                                                                                                                              | Timestamp when the pipeline job was triggered                           |                                                                                                                                                                                                                                     |
| jobCompletedAt `String`                                                                                                                              | Timestamp when the pipeline job completed                               |                                                                                                                                                                                                                                     |
| jobDuration `Int`                                                                                                                                    | Duration of the pipeline job execution in seconds                       |                                                                                                                                                                                                                                     |
| jobTriggeredReason `String`                                                                                                                          | Reason why the pipeline job was triggered                               |                                                                                                                                                                                                                                     |
| jobUrl `String`                                                                                                                                      | URL to view the pipeline job details in the CI/CD platform              |                                                                                                                                                                                                                                     |
| totalIssues `String`                                                                                                                                 | Total number of security issues found in the pipeline scan              |                                                                                                                                                                                                                                     |
| totalBlockingIssues `String`                                                                                                                         | Total number of blocking security issues that prevent deployment        |                                                                                                                                                                                                                                     |
| pullRequestId `String`                                                                                                                               | Pull request identifier if the pipeline was triggered by a PR           |                                                                                                                                                                                                                                     |
| pullRequestUrl `String`                                                                                                                              | URL to view the pull request details                                    |                                                                                                                                                                                                                                     |
| tags [`[TagOutput]`](/api-documentation/api-reference/api--pipeline/types/objects/tag-output.md)                                                     | Tags associated with this pipeline execution                            | <p>tagId <code>String</code><br>tagType <code>String</code><br>name <code>String</code><br>displayName <code>String</code><br>createdBy <code>String</code><br>appliedBy <code>String</code><br>tagCategory <code>String</code></p> |
| issues [`IssuesBySeverity`](/api-documentation/api-reference/api--issue/types/objects/issues-by-severity.md)                                         | Security issues found in the pipeline, categorized by severity          | <p>appox <code>Int</code><br>critical <code>Int</code><br>high <code>Int</code><br>medium <code>Int</code><br>low <code>Int</code><br>info <code>Int</code></p>                                                                     |
| eventType `String`                                                                                                                                   | Type of event that triggered the pipeline (push, pull\_request, manual) |                                                                                                                                                                                                                                     |
| cicdType `String`                                                                                                                                    | CI/CD platform type (GitHub Actions, Jenkins, GitLab CI, etc.)          |                                                                                                                                                                                                                                     |
| scanCompletionStatus [`PipelineScanCompletionStatus`](/api-documentation/api-reference/api--pipeline/types/enums/pipeline-scan-completion-status.md) | Status of the security scan completion                                  |                                                                                                                                                                                                                                     |
| pipelineScanType `String`                                                                                                                            | Type of the security scan performed                                     |                                                                                                                                                                                                                                     |
| artifactInfo [`PipelineArtifactInfo`](/api-documentation/api-reference/api--pipeline/types/objects/pipeline-artifact-info.md)                        | Artifact info related to a container pipeline scan execution            | <p>name <code>String!</code><br>tag <code>String!</code><br>digest <code>String!</code></p>                                                                                                                                         |
| workflows [`[OxWorkflow]`](/api-documentation/api-reference/api--issue/types/objects/ox-workflow.md)                                                 | Workflows related to the scan                                           | <p>id <code>String</code><br>name <code>String</code></p>                                                                                                                                                                           |

### References

#### Fields with this object:

* [{} PipelineSummaryResponse.pipelineSummaries](/api-documentation/api-reference/api--pipeline/types/objects/pipeline-summary-response.md)


---

# 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/types/objects/pipeline-summary.md?ask=<question>
```

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.