leafleafleafFlower illustration
Updated on May 8, 2024
Environment

environment.Tracking

Estimated reading: 5 minutes 608 views
Namespace: Environment
REST: https://[hoster-api-host]/1.0/environment/tracking/rest/{method-name}
Scripting: environment.tracking.{method-name}
This service is responsible for the monitoring of actions performed by the user. Learn more in the documentation.

Methods

GetAction (appid, session, [id] ) :

Returns detailed information on the specific action.

URL

https://[hoster-api-host]/1.0/environment/tracking/rest/getaction

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • id : “int” (optional)

    unique identifier of the target action. An error occurs if the specified action does not exist or does not belong to the current user.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/tracking/rest/getaction?session=[string]&appid=[string]&id=[int]

Response

  • ObjectResponse
    {
   "error": "string",
   "name": "string",
   "object": {
      "action": {
         "actionkey": "string",
         "id": "int",
         "isSafe": "boolean",
         "postEvent": "boolean",
         "preEvent": "boolean",
         "quotas": "string",
         "text": "string",
         "type": "PUBLIC(0) | ADMIN(1) | PROXY(2) | SYSTEM(3) | CMP(4)",
         "useObjectHash": "boolean"
      },
      "actionMark": "string",
      "actionType": "PUBLIC(0) | ADMIN(1) | PROXY(2) | SYSTEM(3) | CMP(4)",
      "appid": "string",
      "args": "string",
      "clientSource": "string",
      "email": "string",
      "error": "string",
      "instanceKey": "string",
      "requestUniqueKey": "string",
      "response": "string",
      "result": "int",
      "serviceName": "string",
      "showResponse": "boolean",
      "text": "string",
      "uid": "int"
   },
   "reason": "int",
   "result": "int",
   "source": "string",
   "warnings": [
      "string",
      "..."
   ]
}

GetCurrentActions (appid, session ) :

Returns a list of the user’s most recent tasks.

URL

https://[hoster-api-host]/1.0/environment/tracking/rest/getcurrentactions

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

Example

Method: POST

https://[hoster-api-host]/1.0/environment/tracking/rest/getcurrentactions?session=[string]&appid=[string]

Response

  • ArrayResponse
    {
   "array": [
      {
         "action": {
            "actionkey": "string",
            "id": "int",
            "isSafe": "boolean",
            "postEvent": "boolean",
            "preEvent": "boolean",
            "quotas": "string",
            "text": "string",
            "type": "PUBLIC(0) | ADMIN(1) | PROXY(2) | SYSTEM(3) | CMP(4)",
            "useObjectHash": "boolean"
         },
         "actionMark": "string",
         "actionType": "PUBLIC(0) | ADMIN(1) | PROXY(2) | SYSTEM(3) | CMP(4)",
         "appid": "string",
         "args": "string",
         "clientSource": "string",
         "email": "string",
         "error": "string",
         "instanceKey": "string",
         "requestUniqueKey": "string",
         "response": "string",
         "result": "int",
         "serviceName": "string",
         "showResponse": "boolean",
         "text": "string",
         "uid": "int"
      },
      "..."
   ],
   "className": "Class",
   "error": "string",
   "name": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}

GetServerUTCTime (appid ) :

Returns the server’s time (UTC).

URL

https://[hoster-api-host]/1.0/environment/tracking/rest/getserverutctime

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

Example

Method: POST

https://[hoster-api-host]/1.0/environment/tracking/rest/getserverutctime?appid=[string]

Response

  • ObjectResponse
    {
   "error": "string",
   "name": "string",
   "object": "date",
   "reason": "int",
   "result": "int",
   "source": "string",
   "warnings": [
      "string",
      "..."
   ]
}

GetUidActions (appid, session, [count], [starttime], [endtime], [actionTypes] ) :

Returns a list of actions performed in the dashboard during the stated period.

URL

https://[hoster-api-host]/1.0/environment/tracking/rest/getuidactions

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • count : “int” (optional)

    returns the specified number of actions from the response (10 by default).

  • starttime : “string” (optional)

    start time (UTC) of a period for which actions should be shown. In the format “yyyy-MM-dd hh:mm:ss”, e.g. “2022-11-16 00:00:00”.

  • endtime : “string” (optional)

    end time (UTC) of a period for which actions should be shown. In the format “yyyy-MM-dd hh:mm:ss”, e.g. “2022-11-16 00:00:00”.

  • actionTypes : “string” (optional)

    a comma-separated list of action types to return (supported values: PUBLIC, SYSTEM).

Example

Method: POST

https://[hoster-api-host]/1.0/environment/tracking/rest/getuidactions?session=[string]&appid=[string]&count=[int]&endtime=[string]&starttime=[string]&actionTypes=[string]

Response

  • ArrayResponse
    {
   "array": [
      {
         "action": {
            "actionkey": "string",
            "id": "int",
            "isSafe": "boolean",
            "postEvent": "boolean",
            "preEvent": "boolean",
            "quotas": "string",
            "text": "string",
            "type": "PUBLIC(0) | ADMIN(1) | PROXY(2) | SYSTEM(3) | CMP(4)",
            "useObjectHash": "boolean"
         },
         "actionMark": "string",
         "actionType": "PUBLIC(0) | ADMIN(1) | PROXY(2) | SYSTEM(3) | CMP(4)",
         "appid": "string",
         "args": "string",
         "clientSource": "string",
         "email": "string",
         "error": "string",
         "instanceKey": "string",
         "requestUniqueKey": "string",
         "response": "string",
         "result": "int",
         "serviceName": "string",
         "showResponse": "boolean",
         "text": "string",
         "uid": "int"
      },
      "..."
   ],
   "className": "Class",
   "error": "string",
   "name": "string",
   "reason": "int",
   "result": "int",
   "source": "string"
}

SearchActions (appid, session, search ) :

Returns a list of actions according to the provided search parameters.

URL

https://[hoster-api-host]/1.0/environment/tracking/rest/searchactions

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • search : “json”

    JSON object with the search parameters:

    {
   "appids": [
      "string",
      "..."
   ],
   "collaboratorUid": "int",
   "endDate": "date",
   "id": "int",
   "login": "string",
   "onlyCompleted": "boolean",
   "onlyErrors": "boolean",
   "orderDirection": "string",
   "orderField": "string",
   "resultCode": "int",
   "resultCount": "int",
   "serviceName": "string",
   "startDate": "date",
   "startRow": "int",
   "types": [
      "..."
   ],
   "uid": "int",
   "value": "string"
}

Example

Method: POST

https://[hoster-api-host]/1.0/environment/tracking/rest/searchactions?search=[json]&session=[string]&appid=[string]

Response

  • PagedArrayResponse
    {
   "array": [
      {
         "action": {
            "actionkey": "string",
            "id": "int",
            "isSafe": "boolean",
            "postEvent": "boolean",
            "preEvent": "boolean",
            "quotas": "string",
            "text": "string",
            "type": "PUBLIC(0) | ADMIN(1) | PROXY(2) | SYSTEM(3) | CMP(4)",
            "useObjectHash": "boolean"
         },
         "actionMark": "string",
         "actionType": "PUBLIC(0) | ADMIN(1) | PROXY(2) | SYSTEM(3) | CMP(4)",
         "appid": "string",
         "args": "string",
         "clientSource": "string",
         "email": "string",
         "error": "string",
         "instanceKey": "string",
         "requestUniqueKey": "string",
         "response": "string",
         "result": "int",
         "serviceName": "string",
         "showResponse": "boolean",
         "text": "string",
         "uid": "int"
      },
      "..."
   ],
   "className": "Class",
   "error": "string",
   "name": "string",
   "reason": "int",
   "result": "int",
   "source": "string",
   "totalCount": "long"
}
Environment - Previous environment.Export Next - Environment environment.Group

Leave a Comment

Powered By AccuWeb.Cloud