Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Security Analysis/ Querying a Table Histogram
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying a Table Histogram

Function

This API is used to query a table histogram.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}/histograms

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.

table_id

Yes

String

Table ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

from

No

Integer

Timestamp, in ms.

to

No

Integer

Timestamp, in ms.

query

Yes

String

Retrieval query criteria. For details about the syntax, see the help documentation.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Long

Total count of results

histograms

Array of SearchQueryResultHistogram objects

histograms
Table 5 SearchQueryResultHistogram

Parameter

Type

Description

count

Long

Total count of results

from

Integer

Timestamp, in ms.

to

Integer

Timestamp, in ms.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded. A log result histogram is returned.

Error Codes

See Error Codes.

Parent topic: Security Analysis