Help Center/ SecMaster/ API Reference/ API/ Playbook Management/ Querying Playbook Statistic Data

Updated on 2024-12-25 GMT+08:00

View PDF

Querying Playbook Statistic Data

Function

This API is used to obtain playbook statistics.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/statistics

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
workspace_id	Yes	String	Workspace ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
content-type	Yes	String	application/json;charset=UTF-8

Response Parameters

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 4** Response body parameters
Parameter	Type	Description
code	String	Error code
message	String	Error Message
data	PlaybookStatisticDetail object	Playbook statistic information.

**Table 5** PlaybookStatisticDetail
Parameter	Type	Description
unapproved_num	Integer	Number of unapproved playbooks.
disabled_num	Integer	Number of playbooks that are not enabled.
enabled_num	Integer	Number of enabled playbooks.

Status code: 400

**Table 6** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Error Code
message	String	Error Description

Example Requests

None

Example Responses

Status code: 200

Response when the request is successful.

{
  "code" : 0,
  "message" : "Error message",
  "data" : {
    "unapproved_num" : 99999999,
    "disabled_num" : 99999999,
    "enabled_num" : 99999999
  }
}