Trend of historical alerts (Beta)

get

https://api.socket.dev/v0/orgs/{org_slug}/historical/alerts/trend

Trend analytics of historical alerts.

This endpoint consumes 10 units of your quota.

This endpoint requires the following org token scopes:

historical:alerts-trend

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

org_slug

string

required

The slug of the organization

Query Params

date

string

Defaults to CURRENT_DATE

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

range

string

Defaults to -7d

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

aggregation.fields

string

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.alertAction

string

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

filters.alertAction.notIn

string

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

filters.alertActionSourceType

string

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

filters.alertActionSourceType.notIn

string

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

filters.alertCategory

string

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

filters.alertCategory.notIn

string

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

filters.alertCveId

string

CVE ID

filters.alertCveId.notIn

string

CVE ID

filters.alertCveTitle

string

CVE title

filters.alertCveTitle.notIn

string

CVE title

filters.alertCweId

string

CWE ID

filters.alertCweId.notIn

string

CWE ID

filters.alertCweName

string

CWE name

filters.alertCweName.notIn

string

CWE name

filters.alertEPSS

string

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

filters.alertEPSS.notIn

string

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

filters.alertFixType

string

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

filters.alertFixType.notIn

string

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

filters.alertKEV

boolean

Defaults to false

Alert KEV (Known Exploited Vulnerability) filter flag

filters.alertKEV.notIn

boolean

Defaults to false

Alert KEV (Known Exploited Vulnerability) filter flag

filters.alertPriority

string

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

filters.alertPriority.notIn

string

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

filters.alertReachabilityAnalysisType

string

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

filters.alertReachabilityAnalysisType.notIn

string

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

filters.alertReachabilityType

string

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.notIn

string

filters.alertSeverity

string

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

filters.alertSeverity.notIn

string

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

filters.alertType

string

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

filters.alertType.notIn

string

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

filters.artifactName

string

Name of artifact

filters.artifactName.notIn

string

Name of artifact

filters.artifactType

string

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

filters.artifactType.notIn

string

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

filters.branch

string

Comma-separated list of branch names that should be included

filters.branch.notIn

string

Comma-separated list of branch names that should be excluded

filters.cvePatchStatus

string

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

filters.cvePatchStatus.notIn

string

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

filters.dependencyDead

boolean

Defaults to false

Dead/reachable dependency filter flag

filters.dependencyDead.notIn

boolean

Defaults to false

Dead/reachable dependency filter flag

filters.dependencyDev

boolean

Defaults to false

Development/production dependency filter flag

filters.dependencyDev.notIn

boolean

Defaults to false

Development/production dependency filter flag

filters.dependencyDirect

boolean

Defaults to false

Direct/transitive dependency filter flag

filters.dependencyDirect.notIn

boolean

Defaults to false

Direct/transitive dependency filter flag

filters.repoFullName

string

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

filters.repoFullName.notIn

string

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

filters.repoLabels

string

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

filters.repoLabels.notIn

string

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

filters.repoSlug

string

Comma-separated list of repo slugs that should be included

filters.repoSlug.notIn

string

Comma-separated list of repo slugs that should be excluded

Responses

200The trend data

400Bad request

401Unauthorized

403Insufficient max_quota for API method

429Insufficient quota for API route