API Reference

List details of periodic historical data snapshots (Beta)

get
https://api.socket.dev/v0/orgs//historical/snapshots

This API endpoint is used to list the details of historical snapshots. Snapshots of organization data are taken periodically, and each historical snapshot record contains high-level overview metrics about the data that was collected. Other Historical Data Endpoints can be used to fetch the raw data associated with each snapshot.

Historical snapshots contain details and raw data for the following resources:

  • Repositories
  • Alerts
  • Dependencies
  • Artifacts
  • Users
  • Settings

Daily snapshot data is bucketed to the nearest day which is described in more detail at: Historical Data Endpoints

This endpoint consumes 10 units of your quota.

This endpoint requires the following org token scopes:

  • historical:snapshots-list
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The slug of the organization

Query Params
string
Defaults to CURRENT_DATE

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

string
Defaults to -7d

The number of days of data to fetch as an offset from input date (e.g. "-7d" or "7d") or use "latest" to query for latest snapshots for each repo

integer
1 to 10000
Defaults to 10000

Specify the maximum number of results to return per page (intermediate pages may have fewer than this limit and callers should always check "endCursor" in response body to know if there are more pages)

string

The pagination cursor that was returned as the "endCursor" property in previous request

string

Comma-separated list of historical snapshot statuses that should be included (allowed: "in-progress", "success", "failure", "timeout", "skipped")

string

Comma-separated list of requestId values that were used to start the historical snapshot job

Responses

Updated 7 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago