Get User Activity Report

Request

URI

POST

https://{api_host}/dt-rest/v100/reporting/manager/useractivityreport

COPY

Query Parameters

string

sortcriteria

Optional

sortcriteria

Possible values are : Id, UserEvent, EventErrorDetails, UserGuid, VMSessionId, VirtualMachineId, DisplayProtocol, EndPointIPAddress, EndPointPlatformType, PatternId, ReportTimeStamp,

string

sortorder

Optional

sortorder

Possible values are : Ascending, Descending,

Request Body

DtUserEventReportFilterImpl of type(s) application/json

Optional

{
    "id": "string",
    "userGuid": "string",
    "eventTypes": [
        "string"
    ],
    "patternId": "string",
    "poolId": "string",
    "remoteAppName": "string",
    "includeVirtualMachineName": false,
    "includePoolName": false,
    "includeUserLoginName": false,
    "displayProtocol": "string",
    "virtualMachineId": "string",
    "numberReportDays": 0,
    "location": "string",
    "DtLink": [
        {
            "href": "string",
            "rel": "string",
            "deprecated": false,
            "name": "string",
            "method": "string"
        }
    ]
}

string

Optional

string

userGuid

Optional

userGuid

array of string

eventTypes

Optional

eventTypes

Possible values are : ALLOCATE, ALLOCATE_FAILURE, LOG_ON, LOG_OFF, DISCONNECT, RECONNECT, SESSION_TIMEOUT, HELPDESK_SENDMESSAGE, HELPDESK_SENDMESSAGE_FAILED, HELPDESK_KILLPROCESS, HELPDESK_KILLPROCESS_FAILED, HELPDESK_REQUEST_REMOTE_ASSIST, HELPDESK_REQUEST_REMOTE_ASSIST_FAILED, HELPDESK_LOGOFF_INITIATED, HELPDESK_DISCONNECT_INITIATED, HELPDESK_KILL_LAUNCHED_APPLICATION, HELPDESK_KILL_LAUNCHED_APPLICATION_FAILED, UNKNOWN,

string

patternId

Optional

patternId

string

poolId

Optional

poolId

string

remoteAppName

Optional

remoteAppName

boolean

includeVirtualMachineName

Optional

includeVirtualMachineName

boolean

includePoolName

Optional

includePoolName

boolean

includeUserLoginName

Optional

includeUserLoginName

string

displayProtocol

Optional

displayProtocol

Possible values are : RDP, VNC, RGS, ICA, NX, PCOIP, BLAST, UNKNOWN, OTHER,

string

virtualMachineId

Optional

virtualMachineId

integer As int32 As int32

numberReportDays

Optional

numberReportDays

string

location

Optional

location

array of DtLink

DtLink

Optional

DtLink

Responses

200

successful operation

Returns DtUserActivity of type(s) */*

{
    "userEventReports": [
        {
            "patternId": "string",
            "poolName": "string",
            "displayProtocol": "string",
            "reportTimestamp": "string",
            "assignmentType": "string",
            "userGuid": "string",
            "userLoginName": "string",
            "userEvent": "string",
            "eventError": "string",
            "eventErrorDetails": "string",
            "datacenterName": "string",
            "virtualMachineId": "string",
            "virtualMachineName": "string",
            "vmsessionId": "string",
            "remoteAppName": "string",
            "endpointPlatformType": "string",
            "endpointIPAddress": "string",
            "id": "string",
            "links": [
                {
                    "href": "string",
                    "rel": "string",
                    "deprecated": false,
                    "name": "string",
                    "method": "string"
                }
            ]
        }
    ],
    "userEventReportCount": 0,
    "userEventReportTotalCount": 0,
    "id": "string",
    "links": [
        {
            "href": "string",
            "rel": "string",
            "deprecated": false,
            "name": "string",
            "method": "string"
        }
    ]
}

array of DtUserEventReport

userEventReports

Optional

userEventReports

integer As int64 As int64

userEventReportCount

Optional

userEventReportCount

integer As int64 As int64

userEventReportTotalCount

Optional

userEventReportTotalCount