List Audits

Retrieves the audits records for the specified customer.

Request

Request-Line

GET /sfd/v2.0/customers/{customerId}/audits HTTP/1.1

Request Parameters

Path Parameters

Parameter	Type	Required	Description
customerId	Integer	Mandatory	Customer ID.

Query Parameters

Parameter	Type	Required	Description
startTime	String	Mandatory	Start time in UTC, ISO-8601 format yyyy-MM-dd'T'HH:mm:ss'Z' (no milliseconds). Example: 2025-03-01T18:00:00Z.
endTime	String	Mandatory	End time in UTC, ISO-8601 format yyyy-MM-dd'T'HH:mm:ss'Z' (no milliseconds). Example: 2025-03-05T09:00:00Z.
account	String	Optional	Account.
clientIp	String	Optional	Client IP address.

Response

Response Body

Parameter	Type	Required	Description
	Array	Mandatory	Array of Audit.

Object: Audit

Property name	Type	Required	Description
account	String	Mandatory	Account.
clientIp	String	Mandatory	Client IP address.
customerId	Integer	Mandatory	Customer ID.
operationType	String	Mandatory	Operation type. Examples: Login, Edit Customer.
detail	String	Optional	Detailed description of the operation. Note: The content may contain HTML tags.
operationTime	String	Mandatory	Operation timestamp in UTC, ISO-8601 format yyyy-MM-dd'T'HH:mm:ss'Z' (no milliseconds). Example: 2025-03-01T18:02:11Z.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	Request.BadRequest	Bad request.
400	Audit.Invalid	The Audit query parameters are incorrect.
400	Time.Invalid	The time format is incorrect.
400	Time.Invalid	The start time cannot be later than the end time.
400	Time.ValueNotSupported	The difference between EndTime and StartTime cannot exceed 30 days.

Examples

List Audits

Request

GET /sfd/v2.0/customers/10025/audits?startTime=2025-03-01T18%3A00%3A00Z&endTime=2025-04-01T00%3A00%3A00Z&account=foo%40example.com&clientIp=192.168.1.24 HTTP/1.1

Successful Response Body

[
    {
        "account": "foo@example.com",
        "clientIp": "192.168.1.24",
        "customerId": 10025,
        "operationType": "Add Account",
        "detail": "account=admin@example.com, name=Example Admin, roles=[Solution Consultant:admin, Finance:view, Biz Ops:view], id=5621",
        "operationTime": "2025-03-01T18:02:11Z"
    },
    {
        "account": "foo@example.com",
        "clientIp": "192.168.1.24",
        "customerId": 10025,
        "operationType": "Add Customer",
        "detail": "name=Example Corp, products=[Content Delivery Network (CDN), Live Media Service (LMS)], id=34356, region=VN, industry=Live & On Demand Video",
        "operationTime": "2025-03-05T08:02:11Z"
    }
]