activitylog

Returns the user’s activity log.

This endpoint returns the user’s activity log, which provides a detailed record of system actions and events for monitoring and auditing purposes.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive data retrieval: Returns a comprehensive activity summary, providing a complete and accurate overview for seamless management and analysis.</br>- Comprehensive error handling: Returns a 404 error code with a clear description when requests fail.</br>- Controlled data limits: The pageSize parameter allows users to define the maximum number of logs to display per page, optimizing data retrieval for specific use cases.</br>- Customizable pagination: The pageNumber parameter allows users to specify the page of results they wish to retrieve, ensuring targeted access to data.</br>- Periodic filtering: Uses the startDate and endDate parameters to filter results, enabling in-depth trend analysis, performance monitoring, and tailored reporting.

get/activitylog

Request

Query parameters

pageSizeinteger

The maximum number of logs to return per page. Defaults to 25 if not specified.

pageNumberinteger

The page of results to return. Defaults to 1 if not specified.

startDatestring

Filters the activity log to include entries starting from this specified date.

endDatestring

Filters the activity log to include entries up to and including this specified date.

Response

Activity log returned successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "id": 1,
      "fullName": "Rob Smith",
      "userId": "456237",
      "requestIp": "12.6.7.89",
      "actionDescription": "Updated the domain.",
      "timestamp": "2024-01-01T00:00:00Z",
      "category": "managed",
      "newValue\"": "{\"sourceId\":7864123,\"failover\":false,\"gtdLocation\":\"DEFAULT ,\"failed\":false,\"monitor\":false,\"dynamicDns\":false,\"hardLink\":false,\"ttl\":300,\"source\":1,\"name\":\"test\",\"value\":\"4.3.2.1\",\"id\":199047675,\"type\":\"A\"}",
      "oldValue": "{\"sourceId\":7864123,\"failover\":false,\"gtdLocation\":\"DEFAULT\",\"failed\":false,\"monitor\":false,\"dynamicDns\":false,\"hardLink\":false,\"ttl\":300,\"source\":1,\"name\":\"test\",\"value\":\"1.2.3.4\",\"id\":199047675,\"type\":\"A\"}"
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.