Obtaining Summary Table Data

Function

This API is used to obtain summary table data.

URI

POST /v1/apm2/openapi/view/metric/sum-table

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
x-business-id	Yes	Long	Application ID.
X-Auth-Token	Yes	String	User token obtained from IAM.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
request_id	No	String	ID of the last request.
view_config	No	SumTableView object	View configuration information.
strategy	No	String	Policy.
page	No	Integer	Current page number.
page_size	No	Integer	Number of data records on each page.
order_by	No	String	Sorting rule.
search_word	No	String	Search keyword.
instance_id	No	Long	Instance ID.
monitor_item_id	No	Long	Monitoring item ID.
env_id	No	Long	Environment ID.
start_time	No	String	Start time.
end_time	No	String	End time.

**Table 3** SumTableView
Parameter	Mandatory	Type	Description
view_type	No	String	View type. Enumeration values: trend sumtable rawtable
collector_name	No	String	Collector name.
metric_set	No	String	Name of the metric set corresponding to the view.
title	No	String	Title to be displayed.
table_direction	No	String	Direction of the table heading. Options: H (default): horizontal. V: vertical. Enumeration values: H V
group_by	No	String	Grouping rule.
filter	No	String	Filter list model.
field_item_list	No	Array of FieldItem objects	Field list models to be displayed.
span	No	Boolean	Span.
span_field	No	String	Span field.
order_by	No	String	Sorting rule.
latest	No	Boolean	Whether to display only the latest data.

**Table 4** FieldItem
Parameter	Mandatory	Type	Description
function	No	String	Expression.
as	No	String	As.
default_value	No	String	Default value.
trace	No	Boolean	Trace or not.
precision	No	Integer	Percentage.
unit	No	String	Unit.
visible	No	Boolean	Visible or not.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
result_id	String	Result ID, which is contained in the pagination query result.
row_list	Array of FrontRow objects	Data row list.
latest_data_Time	Long	Time when the latest data record was generated.
table_direction	String	Direction of the table heading. Options: H (default): horizontal. V: vertical. Enumeration values: H V
real_start_time	Long	Actual start time.
real_end_time	Long	Actual end time.
notice_msg	String	Prompt message.
total_count	Integer	Total number.

**Table 6** FrontRow
Parameter	Type	Description
cell_list	Array of FrontCell objects	Data unit set.
filter	String	"Group by" fields concatenated for subsequent query.
header	Boolean	Whether the information is about the header.
tx_id	Long	URL trace ID.

**Table 7** FrontCell
Parameter	Type	Description
data_type	String	Data type.
function	String	Function.
trace	Boolean	Trace or not.
span	Boolean	Whether the information is related to spans. If yes, you will be redirected to the trace search page.
span_field	String	Span field.
precision	Integer	Number of decimal places.
text	String	Text information.
unit	String	Unit.
visible	Boolean	Visible or not.

Example Requests

Obtain the summary table data. Input parameter view_type is set to sumtable.

/v1/apm2/openapi/view/metric/sum-table

{
  "end_time" : "2022-10-25 15:17:46",
  "env_id" : "11",
  "monitor_item_id" : 78,
  "page" : 1,
  "page_size" : 10,
  "start_time" : "2022-10-25 14:57:46",
  "view_config" : {
    "latest" : null,
    "span" : true,
    "collector_name" : "Url",
    "metric_set" : "url",
    "title" : "URL Summary",
    "table_direction" : null,
    "group_by" : "url,method",
    "filter" : "",
    "field_item_list" : [ {
      "trace" : null,
      "function" : "SUM(invokeCount)",
      "as" : "Calls",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : true
    }, {
      "trace" : null,
      "function" : "SUM(totalTime)/SUM(invokeCount)",
      "as" : "Average response time (ms)",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : true
    }, {
      "trace" : null,
      "function" : "SUM(errorCount)",
      "as" : "Errors",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : true
    }, {
      "trace" : null,
      "function" : "MAX(concurrentMax)",
      "as" : "Maximum concurrency",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : true
    }, {
      "trace" : null,
      "function" : "MAX(maxTime)",
      "as" : "Maximum response time (ms)",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : true
    }, {
      "trace" : null,
      "function" : "SUM(range1)",
      "as" : "0ms-10ms",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : false
    }, {
      "trace" : null,
      "function" : "SUM(range2)",
      "as" : "10ms-100ms",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : false
    }, {
      "trace" : null,
      "function" : "SUM(range3)",
      "as" : "100ms-500ms",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : false
    }, {
      "trace" : null,
      "function" : "SUM(range4)",
      "as" : "500ms-1s",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : false
    }, {
      "trace" : null,
      "function" : "SUM(range5)",
      "as" : "1s-10s",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : false
    }, {
      "trace" : null,
      "function" : "SUM(range6)",
      "as" : "10s-n",
      "default_value" : null,
      "precision" : null,
      "unit" : null,
      "visible" : false
    } ],
    "span_field" : "source",
    "view_type" : "sumtable"
  }
}

Example Responses

None

Status Codes

Status Code	Description
200	OK: The request is successful.
400	Bad Request: Semantic or parameter error.
401	Unauthorized: No permissions.
403	Forbidden: Access forbidden.
404	Not Found: The requested resource is not found.