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

Path Params

org_slug

string

required

The slug of the organization

Query Params

date

string

Defaults to CURRENT_DATE

The UTC date in YYYY-MMM-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,alertType,artifactType,alertAction,alertCategory)

filters.alertAction

string

Defaults to monitor,warn,error

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

filters.alertCategory

string

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

filters.alertSeverity

string

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

filters.alertType

string

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

filters.artifactType

string

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

filters.repoSlug

string

Comma-separated list of repo slugs that should be included

Responses

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.socket.dev/v0/orgs/org_slug/historical/alerts/trend?date=CURRENT_DATE&range=-7d&filters.alertAction=monitor%2Cwarn%2Cerror' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The trend data

400Bad request

401Unauthorized

403Insufficient max_quota for API method

429Insufficient quota for API route