Querying the Custom Event Details Table Based on the Event Name (V2)

Function

This API is used to query the custom event details table based on the event name.

URI

POST /v2/rum/view/custom-events-table/events-key-table-detail/{app_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
app_id	Yes	String	Website ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
start_timestamp	No	String	Start time.
end_timestamp	No	String	End time.
url	No	String	URL to query.
custom_key	No	String	Event name to query.
str_val	No	String	Event value to query.
page	No	Integer	Page number.
page_size	No	Integer	Number of records on each page.
order_by	No	String	Sorting order.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of records in a table.
row_list	Array of row_list objects	Table list.

**Table 5** row_list
Parameter	Type	Description
empty	Boolean	-

Example Requests

Query the custom event details table based on the event name.

/v2/rum/view/custom-events-table/events-key-table-detail/{app_id}

{
  "page" : 1,
  "page_size" : 10,
  "start_timestamp" : "-20m",
  "end_timestamp" : "now",
  "custom_key" : "User Information"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "total_count" : 1,
  "row_list" : [ [ "str_val", "url", "invoke_count", "max_num_val", "min_num_val", "avg_num_val", "uv", "invoke_count_per_person" ], [ "abc", "http%3A%2F%2Flocalhost%3A8087%2Findex.html", 430, 0, 0, 0, 1, 430 ] ]
}

Status code: 400

Bad Request: Semantic or parameter error.

{
  "error_code" : "apm2.00000001",
  "error_msg" : "internal error",
  "hint" : null
}

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.