> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Scan Summary

Get an aggregated SAST results summary for the specified scan.

<Note>
  External Documentation

  To learn more, visit the [Checkmarx One documentation](https://checkmarx.stoplight.io/docs/checkmarx-one-api-reference-guide/ir9wg7kfz8gvo-retrieve-aggregated-summary-of-sast-results).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter                | Description                                                                                                                                                   |
  | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Apply Predicates         | Select to consider predicate changes rather than raw predicate values.                                                                                        |
  | First Found At           | A timestamp indicating when the item was first detected to filter by.<br /><br />**Note:** This should be used with the `First Found At Operation` parameter. |
  | First Found At Operation | The comparison operator to apply when filtering using the `First Found At` parameter.                                                                         |
  | Group By Field           | Group the results by specific fields.                                                                                                                         |
  | Language                 | A comma-separated list of languages to filter results by.<br /><br />**Note:** Use an exact match, the comparison is case-insensitive.                        |
  | Notes                    | Last notes content used to filter results by.<br /><br />**Note:** This should be used with the `Notes Operation` parameter.                                  |
  | Notes Operation          | The comparison operator to apply when filtering by the `Notes` parameter.                                                                                     |
  | Return All Pages         | Automatically fetch all resources, page by page.                                                                                                              |
  | Scan ID                  | The scan ID.                                                                                                                                                  |
  | Severity                 | The severity level to filter results by.                                                                                                                      |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter                 | Description                                                                                                                        |
  | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
  | Correlation ID            | A unique identifier used to track a single request across multiple services.                                                       |
  | Limit                     | The maximum number of items to return per page.                                                                                    |
  | Number Of Nodes           | The number of nodes to filter results by.<br /><br />**Note:** This should be used with the `Number Of Nodes Operation` parameter. |
  | Number Of Nodes Operation | The comparison operator to use when filtering by the `Number Of Nodes` parameter.                                                  |
  | Offset                    | The offset of the item at which to begin the response.                                                                             |
  | Preset ID                 | The preset ID to filter results by.                                                                                                |
  | Query IDs                 | A comma-separated list of query IDs to filter results by.                                                                          |
  | Result IDs                | A comma-separated list of unique result IDs to filter the results by.                                                              |
  | Sink File Name            | The sink file name to filter results by.<br /><br />**Note:** This should be used with the `Sink File Name Operation` parameter.   |
  | Sink File Name Operation  | Specify the operator applied when filtering results by the `Sink File Name` parameter.                                             |
  | Sink Line                 | The sink line to filter results by.<br /><br />**Note:** This should be used with the `Sink Line Operation` parameter.             |
  | Sink Line Operation       | The comparison operator to use when filtering by the `Sink Line` parameter.                                                        |
  | Sink Node                 | The sink node to filter results by.<br /><br />**Note:** This should be used with the `Sink Node Operation` parameter.             |
  | Sink Node Operation       | The comparison operator to use when filtering results by the `Sink Node` parameter.                                                |
  | Source File               | The source file to filter results by.<br /><br />**Note:** This should be used with the `Source File Operation` parameter.         |
  | Source File Operation     | The comparison operator to use when filtering results by the `Source File` parameter.                                              |
  | Source Line               | The source line to filter results by.<br /><br />**Note:** This should be used with the `Source Line Operation` parameter.         |
  | Source Line Operation     | The comparison operator to use when filtering results by the `Source Line` parameter.                                              |
  | Source Node               | The source node to filter results by.<br /><br />**Note:** This should be used with the `Source Node Operation` parameter.         |
  | Source Node Operation     | The comparison operator to use when filtering results by the `Source Node` parameter.                                              |
  | Status                    | The status to filter results by.                                                                                                   |
</div>

## Example Output

```json theme={"dark"}
{
	"summaries": [
		{
			"queryID": "729519850006803664",
			"queryName": "Missing_CSP_Header",
			"severity": "LOW",
			"count": 1
		},
		{
			"queryID": "3339566533927886347",
			"queryName": "Client_JQuery_Deprecated_Symbols",
			"severity": "LOW",
			"count": 4
		}
	],
	"totalCount": 2
}
```

## Workflow Library Example

[Get Scan Summary with Checkmarx One and Send Results Via Email](https://library.blinkops.com/workflows/get-scan-summary-with-checkmarx-one-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/get-scan-summary-with-checkmarx-one-and-send-results-via-email/canvas" />
</div>
