v1

latestOpenAPI 3.0.02026-07-249055687.1 KB
alerts

Trend of historical alerts (Beta)

Trend analytics of historical alerts.

This endpoint consumes 10 units of your quota.

This endpoint requires the following org token scopes:

  • historical:alerts-trend
get/orgs/{org_slug}/historical/alerts/trend

Path parameters

org_slugstring required

The slug of the organization

Query parameters

datestring

The UTC date in YYYY-MM-DD format for which to fetch alerts

rangestring

The number of days of data to fetch as an offset from input date

aggregation.fieldsstring

Comma-separated list of fields that should be used for count aggregation (allowed: alertSeverity,repoSlug,repoFullName,branch,repoLabels,alertType,artifactType,alertAction,alertActionSourceType,alertFixType,alertCategory,alertCveId,alertCveTitle,alertCweId,alertCweName,alertReachabilityType,cvePatchStatus,alertReachabilityAnalysisType,alertPriority,alertKEV,alertEPSS,dependencyDirect,dependencyDev,dependencyDead)

filters.alertActionstring

Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included

filters.alertAction.notInstring

Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded

filters.alertActionSourceTypestring

Comma-separated list of alert action source types ("resolution", "alert-policy", "fallback", "injected-alert", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included

filters.alertActionSourceType.notInstring

Comma-separated list of alert action source types ("resolution", "alert-policy", "fallback", "injected-alert", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded

filters.alertCategorystring

Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be included

filters.alertCategory.notInstring

Comma-separated list of alert categories ("supplyChainRisk", "maintenance", "quality", "license", or "vulnerability") that should be excluded

filters.alertCveIdstring

CVE ID

filters.alertCveId.notInstring

CVE ID

filters.alertCveTitlestring

CVE title

filters.alertCveTitle.notInstring

CVE title

filters.alertCweIdstring

CWE ID

filters.alertCweId.notInstring

CWE ID

filters.alertCweNamestring

CWE name

filters.alertCweName.notInstring

CWE name

filters.alertEPSSstring

Alert EPSS ("low", "medium", "high", "critical")

filters.alertEPSS.notInstring

Alert EPSS ("low", "medium", "high", "critical")

filters.alertFixTypestring

Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be included

filters.alertFixType.notInstring

Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded

filters.alertKEVboolean

Alert KEV (Known Exploited Vulnerability) filter flag

filters.alertKEV.notInboolean

Alert KEV (Known Exploited Vulnerability) filter flag

filters.alertPrioritystring

Alert priority ("low", "medium", "high", or "critical")

filters.alertPriority.notInstring

Alert priority ("low", "medium", "high", or "critical")

filters.alertReachabilityAnalysisTypestring

Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be included

filters.alertReachabilityAnalysisType.notInstring

Comma-separated list of alert CVE reachability analysis types ("full-scan" or "precomputed") that should be excluded

filters.alertReachabilityTypestring

Comma-separated list of alert CVE reachability types ("direct_dependency", "error", "maybe_reachable", "missing_support", "pending", "reachable", "undeterminable_reachability", "unknown", or "unreachable") that should be included

filters.alertReachabilityType.notInstring

Comma-separated list of alert CVE reachability types ("direct_dependency", "error", "maybe_reachable", "missing_support", "pending", "reachable", "undeterminable_reachability", "unknown", or "unreachable") that should be excluded

filters.alertSeveritystring

Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be included

filters.alertSeverity.notInstring

Comma-separated list of alert severities ("low", "medium", "high", or "critical") that should be excluded

filters.alertTypestring

Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be included

filters.alertType.notInstring

Comma-separated list of alert types (e.g. "usesEval", "unmaintained", etc.) that should be excluded

filters.artifactNamestring

Name of artifact

filters.artifactName.notInstring

Name of artifact

filters.artifactTypestring

Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be included

filters.artifactType.notInstring

Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded

filters.branchstring

Comma-separated list of branch names that should be included

filters.branch.notInstring

Comma-separated list of branch names that should be excluded

filters.cvePatchStatusstring

Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be included

filters.cvePatchStatus.notInstring

Comma-separated list of patch statuses ("patch_unavailable", "patch_available", or "patch_applied") that should be excluded

filters.dependencyDeadboolean

Dead/reachable dependency filter flag

filters.dependencyDead.notInboolean

Dead/reachable dependency filter flag

filters.dependencyDevboolean

Development/production dependency filter flag

filters.dependencyDev.notInboolean

Development/production dependency filter flag

filters.dependencyDirectboolean

Direct/transitive dependency filter flag

filters.dependencyDirect.notInboolean

Direct/transitive dependency filter flag

filters.repoFullNamestring

Comma-separated list of repo full names that should be included

filters.repoFullName.notInstring

Comma-separated list of repo full names that should be excluded

filters.repoLabelsstring

Comma-separated list of repo labels that should be included. Use "" to filter for repositories with no labels.

filters.repoLabels.notInstring

Comma-separated list of repo labels that should be excluded. Use "" to filter for repositories with no labels.

filters.repoSlugstring

Comma-separated list of repo slugs that should be included

filters.repoSlug.notInstring

Comma-separated list of repo slugs that should be excluded

Response

The trend data