Jump to

• Request
• Response
• Examples

Get All Performance Log Events

get

/rest/v16/performanceLogs

This operation retrieves Performance Log events.

Request

Query Parameters

• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Default Response

Body ()

Root Schema : Performance Log Response

Type: object

Show Source

• applicationVersion: string
  Title: Application Version

  The version of the application
• browserTime: integer
  Title: Browser Time

  The time the end user perceived the action to take (in ms).
• browserVersion: string
  Title: Browser Version

  The version of the browser
• component: string
  Title: Action

  The name of the action
• createdDate: string
  Title: Created Date

  System field indicating the date on which the object was created.
• event: string
  Title: Event Type

  The type of event that occurred
• eventDate: string
  Title: Event Date

  The Datetime on which the event occurred.
• id: integer
  Title: Id

  Primary Key of Log Application Events
• ipAddress: string
  Title: Ip Address

  The IP address of the user.
• login: string
  Title: Login

  The log-in of the user that performance the action.
• modifiedDate: string
  Title: Modified Date

  System field indicating the date on which the object was last modified.
• node: string
  Title: Server Node

  The server on which the logic executed.
• referenceObject: string
  Title: Object

  The object upon which the action was performed
• requestId: string
  Title: Request Id

  The request id for the event.
• serverTime: integer
  Title: Server Time

  Time Elapsed in Milliseconds
• sessionId: string
  Title: User Session Id

  The user session id.
• transactionId: integer
  Title: Transaction Id

  Transaction Id
• url: string
  Title: URL

  The URL invoked by the user.

{
    "properties":{
        "serverTime":{
            "title":"Server Time",
            "description":"Time Elapsed in Milliseconds",
            "type":"integer"
        },
        "url":{
            "title":"URL",
            "description":"The URL invoked by the user. ",
            "type":"string"
        },
        "applicationVersion":{
            "title":"Application Version",
            "description":"The version of the application",
            "type":"string"
        },
        "createdDate":{
            "title":"Created Date",
            "description":"System field indicating the date on which the object was created.",
            "type":"string"
        },
        "component":{
            "title":"Action",
            "description":"The name of the action ",
            "type":"string"
        },
        "transactionId":{
            "title":"Transaction Id",
            "description":"Transaction Id",
            "type":"integer"
        },
        "id":{
            "title":"Id",
            "description":"Primary Key of Log Application Events",
            "type":"integer"
        },
        "event":{
            "title":"Event Type",
            "description":"The type of event that occurred ",
            "type":"string"
        },
        "requestId":{
            "title":"Request Id",
            "description":"The request id for the event.",
            "type":"string"
        },
        "sessionId":{
            "title":"User Session Id",
            "description":"The user session id.",
            "type":"string"
        },
        "referenceObject":{
            "title":"Object",
            "description":"The object upon which the action was performed ",
            "type":"string"
        },
        "eventDate":{
            "title":"Event Date",
            "description":"The Datetime on which the event occurred.",
            "type":"string"
        },
        "modifiedDate":{
            "title":"Modified Date",
            "description":"System field indicating the date on which the object was last modified.",
            "type":"string"
        },
        "login":{
            "title":"Login",
            "description":"The log-in of the user that performance the action. ",
            "type":"string"
        },
        "browserVersion":{
            "title":"Browser Version",
            "description":"The version of the browser ",
            "type":"string"
        },
        "browserTime":{
            "title":"Browser Time",
            "description":"The time the end user perceived the action to take (in ms). ",
            "type":"integer"
        },
        "ipAddress":{
            "title":"Ip Address",
            "description":"The IP address of the user.",
            "type":"string"
        },
        "node":{
            "title":"Server Node",
            "description":"The server on which the logic executed.",
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to access Performance Logs items by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/performanceLogs?q={$and:[{component:{$eq: 'jdoe'}},{$or:[{event:{$eq: "Login"}},{browserTime:{$exists: true}}]}]}&orderby=eventDate:desc

Response Body Sample

The following example shows the contents of the response body in JSON format, including Performance Logs items:

{
  "items": [{
    "eventDate": "2016-02-23 19:09:44.0",
    "transactionId": null,
    "browserVersion": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36",
    "requestId": "c0733238-7904-4170-aa17-e66ed4cf606a",
    "referenceObject": "Login",
    "modifiedDate": "2016-02-23 00:00:00.0",
    "url": "https://sitename.oracle.com:80/commerce/display_company_profile.jsp",
    "id": "707",
    "applicationVersion": "15.2.0",
    "node": "node1",
    "component": "jdoe",
    "sessionId": "PGKxWMnSbFnR9VXGF2CSWBJ0JGpfyyp2xCSmzR3phDNBhxs7fRyz!-2116935037!1456254578753",
    "event": "Login",
    "serverTime": "22",
    "login": "<none>",
    "browserTime": null,
    "createdDate": "2016-02-23 00:00:00.0",
    "ipAddress": "0:0:0:0:0:0:0:1",
    "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/performanceLogs/707"
    }]
  },
  {
    "eventDate": "2016-02-23 19:09:56.0",
    "transactionId": null,
    "browserVersion": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36",
    "requestId": "7c94952e-df28-433a-9113-ea7b1852b8e5",
    "referenceObject": "Login",
    "modifiedDate": "2016-02-23 00:00:00.0",
    "url": "https://sitename.oracle.com:80/commerce/display_company_profile.jsp",
    "id": "710",
    "applicationVersion": "15.2.0",
    "node": "node1",
    "component": "jdoe",
    "sessionId": "ttcZWMnpcSb04BXYn1f7hsqQLRxdkNLLnVxdnCbSLmhQLK4sBnyV!-2116935037!1456254590423",
    "event": "Login",
    "serverTime": "8",
    "login": "<none>",
    "browserTime": "940",
    "createdDate": "2016-02-23 00:00:00.0",
    "ipAddress": "0:0:0:0:0:0:0:1",
    "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/performanceLogs/710"
    }]
  }],
  "links": [{
    "rel": "self",
    "href": "https://sitename.oracle.com/rest/v16/performanceLogs"
  }]
}

Back to Top