FortWatchFortWatchDocs
Menu

Get the period summary

GEThttps://api.fortwatch.ai/app/reports/summary
Scope reports:readOperation ID getReportSummary

New, fixed and open issues, findings by severity and scan counts for a period (the last 30 days by default), for the workspace, a project or an asset.

Parameters

NameInTypeDescription
projectIdqueryintegerOnly this project's numbers.
assetIdqueryintegerOnly this asset's numbers.
fromquerystring
toquerystring

Example request

curl -X GET "https://api.fortwatch.ai/app/reports/summary" \
  -H "Authorization: Bearer $FORTWATCH_API_KEY"

Response 200

The request succeeded.

FieldTypeDescription
periodrequiredobject
issuesrequiredobject
findingsrequiredobject
scansrequiredobject
recentScansrequiredobject[]
json
{
  "period": {},
  "issues": {},
  "findings": {},
  "scans": {},
  "recentScans": [
    {}
  ]
}

Errors

400The request is not valid: a field is missing or has the wrong shape (the message names it).
401No valid credentials: the API key or access token is missing, revoked or expired (INVALID_API_KEY, INVALID_TOKEN).
403Not allowed: the key or token lacks this scope (SCOPE_REQUIRED), the route is dashboard-only (SESSION_REQUIRED), or a plan limit applies.
429Too many requests (RATE_LIMITED): wait the seconds Retry-After gives.