Skip to content

Get API Access Log Page ​

Paginated query of API access logs.

Interface Address:

text
/papi/zw/log/api-access/page

Request Method:

text
POST

Content-Type:

text
application/json

Header Parameters:

ParameterTypeRequiredDescription
X-Access-KeystringYesAPI access key ID. For authentication, see API Rules
X-SignaturestringYesSignature value, Base64-encoded HMAC-SHA256 result
X-TimestampstringYesMillisecond-level Unix timestamp (13 digits)
X-NoncestringYesRandom string, 10-32 lowercase letters and digits

Body Parameters:

ParameterTypeRequiredDescription
pageNointegerNoPage number, starting from 1, default 1
pageSizeintegerNoNumber of items per page, maximum 1000, default 10
requestMethodstringNoRequest method, e.g. GET/POST
requestUrlstringNoRequest URL, fuzzy match
resultCodeintegerNoResult code, 0 indicates success, non-0 indicates failure
startTimearray[integer]NoTime range, array of length 2: [start timestamp, end timestamp], unit: milliseconds

Request Example:

json
{
  "pageNo": 1,
  "pageSize": 10
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataobjectPaginated data
├─ listarray[object]Log list
├─├─ traceIdstringTrace ID
├─├─ userIdintegerUser ID
├─├─ requestMethodstringRequest method name
├─├─ requestUrlstringRequest URL
├─├─ requestParamsstringRequest parameters
├─├─ userIpstringUser IP
├─├─ userAgentstringBrowser user agent
├─├─ beginTimeintegerRequest start time, millisecond timestamp
├─├─ endTimeintegerRequest end time, millisecond timestamp
├─├─ durationintegerExecution duration, unit: milliseconds
├─├─ resultCodeintegerResult code
├─├─ resultMsgstringResult message
├─├─ createTimeintegerCreation time, millisecond timestamp
├─ totalintegerTotal count
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": {
    "list": [
      {
        "traceId": "",
        "userId": 0,
        "requestMethod": "POST",
        "requestUrl": "/papi/zw/log/api-access/page",
        "requestParams": "",
        "userIp": "192.168.1.1",
        "userAgent": "Mozilla/5.0",
        "beginTime": 1723968000000,
        "endTime": 1723968001000,
        "duration": 100,
        "resultCode": 0,
        "resultMsg": "success",
        "createTime": 1723968000000
      }
    ],
    "total": 100
  },
  "msg": ""
}

OpenAPI Docs