Sign in

v1

latestOpenAPI 3.0.02026-08-0417295208.0 KB
reports

Endpoint to get artifact downloaded event reports

Generates artifact downloaded report for records satisfying given filter conditions.

  • This feature is only available for admin users.
  • from_date, to_date and download_as are mandatory fields.
  • usernames list and channel names list are optional fields.
  • Example: If you enter a date duration, give list of channel names, list of user names in the request, you get a report of artifact downloaded details downloaded during that duration AND (from the channel names given OR downloaded by what users specified).
post/reports/artifact_downloads

Request body

from_datestring date required
  • Report start date.
  • Supported date formats:
    • '%Y-%m-%d'
to_datestring date required
  • Report end date.
  • Supported date formats:
    • '%Y-%m-%d'
download_as'json' | 'csv' required
  • Specifies the format of report download file.
  • The report name will follow the convention ArtifactsReport_{timestamp('%Y%m%d_%H%M%S')}
channel_namesstring[] nullable

List of Channel names

user_namesstring[] nullable

List of user names

Response

Returns artifact download report file successfully based on download_as option selected

Example response

{
  "items": [
    {
      "cve_information": [
        {
          "id": "CVE-2019-9948"
        }
      ]
    }
  ]
}