Reporting API (v1)

This document uses the v1 API. For more details, see the v1 API.

Get list of latest issues

Returns issues currently in existence. This data can take up to 9 hours to refresh

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

POSThttps://api.snyk.io/v1/reporting/issues/latest

Query parameters

Body

application/json

filtersfilters6

any

Response

200400

Body

application/json; charset=utf-8

results*array of one of

A list of issues

total*number

The total number of results found

Request

JavaScriptCurl

const response = await fetch('https://api.snyk.io/v1/reporting/issues/latest', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {
        "orgs": [],
        "severity": [
          "critical",
          "high",
          "medium",
          "low"
        ],
        "exploitMaturity": [
          "mature",
          "proof-of-concept",
          "no-known-exploit",
          "no-data"
        ],
        "types": [
          "vuln",
          "license",
          "configuration"
        ],
        "languages": [
          "node",
          "javascript",
          "ruby",
          "java",
          "scala",
          "python",
          "golang",
          "php",
          "dotnet",
          "swift-objective-c",
          "elixir",
          "docker",
          "linux",
          "dockerfile",
          "terraform",
          "kubernetes",
          "helm",
          "cloudformation",
          "arm"
        ],
        "projects": [],
        "issues": [],
        "identifier": "",
        "ignored": false,
        "patched": false,
        "fixable": false,
        "isFixed": false,
        "isUpgradable": false,
        "isPatchable": false,
        "isPinnable": false,
        "priorityScore": {
          "min": 0,
          "max": 1000
        }
      }
    }),
});
const data = await response.json();

Response

{
  "results": [
    [
      {
        "url": "text",
        "id": "text",
        "name": "text",
        "source": "text",
        "packageManager": "text",
        "targetFile": "text"
      }
    ]
  ],
  "total": 0
}

Get list of issues

Returns any issues that are present during the specified timeframe. For example, if an issue from 2018 is still considered a vulnerable today, it will show up in all reports from its inception to the current day. This data updates once per hour.Note: A vulnerability that was introduced and then resolved on the same day will not show up in the response.

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

POSThttps://api.snyk.io/v1/reporting/issues/

Query parameters

Body

application/json

filtersfilters6

any

Response

200400

Body

application/json; charset=utf-8

results*array of one of

A list of issues

total*number

The total number of results found

Request

JavaScriptCurl

const response = await fetch('https://api.snyk.io/v1/reporting/issues/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {
        "orgs": [],
        "severity": [
          "critical",
          "high",
          "medium",
          "low"
        ],
        "exploitMaturity": [
          "mature",
          "proof-of-concept",
          "no-known-exploit",
          "no-data"
        ],
        "types": [
          "vuln",
          "license",
          "configuration"
        ],
        "languages": [
          "node",
          "javascript",
          "ruby",
          "java",
          "scala",
          "python",
          "golang",
          "php",
          "dotnet",
          "swift-objective-c",
          "elixir",
          "docker",
          "linux",
          "dockerfile",
          "terraform",
          "kubernetes",
          "helm",
          "cloudformation",
          "arm"
        ],
        "projects": [],
        "issues": [],
        "identifier": "",
        "ignored": false,
        "patched": false,
        "fixable": false,
        "isFixed": false,
        "isUpgradable": false,
        "isPatchable": false,
        "isPinnable": false,
        "priorityScore": {
          "min": 0,
          "max": 1000
        }
      }
    }),
});
const data = await response.json();

Response

{
  "results": [
    [
      {
        "url": "text",
        "id": "text",
        "name": "text",
        "source": "text",
        "packageManager": "text",
        "targetFile": "text"
      }
    ]
  ],
  "total": 0
}

Get test counts

Returns the number of tests conducted within a time frame. This data is updated in real time

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

POSThttps://api.snyk.io/v1/reporting/counts/tests

Query parameters

Body

application/json

filtersfilters9

any

Response

200400

Body

application/json; charset=utf-8

results*array of results5

A list of test counts

any

Request

JavaScriptCurl

const response = await fetch('https://api.snyk.io/v1/reporting/counts/tests', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {
        "orgs": [],
        "isPrivate": false,
        "issuesPrevented": false,
        "projects": []
      }
    }),
});
const data = await response.json();

Response

{
  "results": [
    {
      "count": 0,
      "isPrivate": {
        "true": 0,
        "false": 0
      }
    }
  ]
}

Get project counts

Returns project counts within a time frame. This data can take up to 9 hours to refresh

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

POSThttps://api.snyk.io/v1/reporting/counts/projects

Query parameters

Body

application/json

filtersfilters8

any

Response

200400

Body

application/json; charset=utf-8

results*array of results4

A list of project counts by day

any

Request

JavaScriptCurl

const response = await fetch('https://api.snyk.io/v1/reporting/counts/projects', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {
        "orgs": [],
        "languages": [
          "node",
          "javascript",
          "ruby",
          "java",
          "scala",
          "python",
          "golang",
          "php",
          "dotnet",
          "swift-objective-c",
          "elixir",
          "docker",
          "linux",
          "dockerfile",
          "terraform",
          "kubernetes",
          "helm",
          "cloudformation"
        ],
        "projects": []
      }
    }),
});
const data = await response.json();

Response

{
  "results": [
    {
      "day": "2017-07-01",
      "count": 0
    },
    {
      "day": "2017-07-02",
      "count": 0
    },
    {
      "day": "2017-07-03",
      "count": 0
    }
  ]
}

Get latest project counts

Returns the number of projects currently in existence. This data can take up to 9 hours to refresh.

• Params#### Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

POSThttps://api.snyk.io/v1/reporting/counts/projects/latest

Body

application/json

filtersfilters8

any

Response

200400

Body

application/json; charset=utf-8

results*array of results4

A list of project counts by day

any

Request

JavaScriptCurl

const response = await fetch('https://api.snyk.io/v1/reporting/counts/projects/latest', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {
        "orgs": [],
        "languages": [
          "node",
          "javascript",
          "ruby",
          "java",
          "scala",
          "python",
          "golang",
          "php",
          "dotnet",
          "swift-objective-c",
          "elixir",
          "docker",
          "linux",
          "dockerfile",
          "terraform",
          "kubernetes",
          "helm",
          "cloudformation"
        ],
        "projects": []
      }
    }),
});
const data = await response.json();

Response

{
  "results": [
    {
      "day": "2017-07-01",
      "count": 0
    }
  ]
}

Get issue counts

Returns issue counts within a time frame. This data can take up to 9 hours to refresh

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

POSThttps://api.snyk.io/v1/reporting/counts/issues

Query parameters

Body

application/json

filtersfilters7

any

Response

200400

Body

application/json; charset=utf-8

results*array of results3

A list of issue counts by day

any

Request

JavaScriptCurl

const response = await fetch('https://api.snyk.io/v1/reporting/counts/issues', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {
        "orgs": [],
        "severity": [
          "critical",
          "high",
          "medium",
          "low"
        ],
        "types": [
          "vuln",
          "license",
          "configuration"
        ],
        "languages": [
          "node",
          "javascript",
          "ruby",
          "java",
          "scala",
          "python",
          "golang",
          "php",
          "dotnet",
          "swift-objective-c",
          "elixir",
          "docker",
          "linux",
          "dockerfile",
          "terraform",
          "kubernetes",
          "helm",
          "cloudformation"
        ],
        "projects": [],
        "ignored": false,
        "patched": false,
        "fixable": false,
        "isUpgradable": false,
        "isPatchable": false,
        "isPinnable": false,
        "priorityScore": {
          "min": 0,
          "max": 1000
        }
      }
    }),
});
const data = await response.json();

Response

{
  "results": [
    {
      "day": "2017-07-01",
      "count": 0,
      "severity": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0
      }
    },
    {
      "day": "2017-07-02",
      "count": 0,
      "severity": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0
      }
    },
    {
      "day": "2017-07-03",
      "count": 0,
      "severity": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0
      }
    }
  ]
}

Get latest issue counts

Returns the number of issues currently in existence. This data can take up to 9 hours to refresh

Required permissions

• View Project for every Organization in filters.orgs

• View Organization Reports for every Organization in filters.orgs

POSThttps://api.snyk.io/v1/reporting/counts/issues/latest

Query parameters

Body

application/json

filtersfilters7

any

Response

200400

Body

application/json; charset=utf-8

results*array of results3

A list of issue counts by day

any

Request

JavaScriptCurl

const response = await fetch('https://api.snyk.io/v1/reporting/counts/issues/latest', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {
        "orgs": [],
        "severity": [
          "critical",
          "high",
          "medium",
          "low"
        ],
        "types": [
          "vuln",
          "license",
          "configuration"
        ],
        "languages": [
          "node",
          "javascript",
          "ruby",
          "java",
          "scala",
          "python",
          "golang",
          "php",
          "dotnet",
          "swift-objective-c",
          "elixir",
          "docker",
          "linux",
          "dockerfile",
          "terraform",
          "kubernetes",
          "helm",
          "cloudformation"
        ],
        "projects": [],
        "ignored": false,
        "patched": false,
        "fixable": false,
        "isUpgradable": false,
        "isPatchable": false,
        "isPinnable": false,
        "priorityScore": {
          "min": 0,
          "max": 1000
        }
      }
    }),
});
const data = await response.json();

Response

{
  "results": [
    {
      "day": "2017-07-01",
      "count": 0,
      "severity": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0
      }
    }
  ]
}