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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| workspace_id | Yes | String | Workspace ID |
Request 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
| Parameter | Type | Description |
|---|---|---|
| X-request-id | String | Request ID, in the format request_uuid-timestamp-hostname. |
| Parameter | Type | Description |
|---|---|---|
| code | String | Error code |
| message | String | Error Message |
| data | PlaybookStatisticDetail object | Playbook statistic information. |
| 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
| Parameter | Type | Description |
|---|---|---|
| X-request-id | String | Request ID, in the format request_uuid-timestamp-hostname. |
| 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
}
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Response when the request is successful. |
| 400 | Response when the request failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
