Count Number of Jobs API

Use this API to fetch the total count of script jobs executed.

GET /sm/v1/jobs/count

Input ParametersInput Parameters

Parameter Mandatory/Optional Data Type Description
query Optional String Search for jobs based on values as such script ID, script category and so on.
startAt/endAt
Optional
String
Search for script jobs by specifying the start date/end date.
groupBy
Optional
String Group script jobs by status, asset.operatingSystem, script.name, script.type, and script.category parameters.

Sample 1: Get the Total Count of Script Jobs with startAt and endAt ValuesSample 1: Get the Total Count of Script Jobs with startAt and endAt Values

API Request

 "curl --location --request GET""https://<qualys_base_url>/sm/v1/jobs/count?startAt=2023-01-01T00:00:01.000Z&endAt=2023-01-09T23:59:59.000Z""\\
--header""'Authorization: <Bearer Token>"

Response

 {
   "   ""data":{
      "       ""count":119
   
   },
   "   ""timestamp":"2023-01-12T05:50:55.598Z"
}          

Sample 2: Get the Total Count of Script Jobs by Specifying groupBy=script.category as Query ParameterSample 2: Get the Total Count of Script Jobs by Specifying groupBy=script.category as Query Parameter

API Request

 "curl --location --request GET""https://<qualys_base_url>/sm/v1/jobs/count?groupBy=script.category""\\
--header""'Authorization: <Bearer Token>"

Response

 {
   "   ""data":{
      "       ""Data Backup":86,
      "       ""Remediation":58,
      "       ""Data Collection":11,
      "       ""General Automation":10
   
   },
   "   ""timestamp":"2023-01-12T05:51:20.157Z"
}