Search using Activity Log API

For each tenant, Reltio Cloud stores and shares information about user actions and activities.

Reltio stores and shares information about user actions and activities in a tenant. All Rest API requests that modify data and all requests with a special header are tracked. Also, there are abilities to get an activity log for a user, filter the log by some criteria, and so on.

By default, all activities that result in changes (such as entity changes, interaction changes, tenant configuration changes, and so on) are tracked in the activity logs. Each activity log record auto-generates a URI. All items in the record contain information about each changed object (entity, relation, interaction, and so on) including Rest API HTTP method, HTTP URL, changes in attributes, and applied match rules (for Merge events).

To request activity log messages that correspond to hidden attributes, use the hidden=true request parameter. For more information about the hidden parameter, see Attributes configuration. By default it is set to false, meaning that only non-hidden attribute messages appear in the activity log view.

Client activity may be tracked in the log. For example, REST API requests that do not make any changes (Read-only) or any other kind of activity that the client application wants to track. All Read-only requests must be sent to the API with the additional ActivityID header and a unique value for that header.

Activity log is immutable, which means that it can not be altered or the previous activities can not be overwritten. Therefore, using the same ActivityID header with other API requests does not overwrite an existing activity.

Returning Activity Log Data

By default, the Activity Log API returns results for the last four months. To extend the time period, specify the filter query parameter for timestamp. For example, by using the filter=gt(timestamp,1560800276000) query, all the activities from 'June 17, 2019, 7:37:56 PM' are returned. The timestamp must be mentioned in milliseconds.

To know more about the filter query parameter and the timestamp details, see the following topics:

Retention and searching against the activity log data is governed by Quotas and Limits. For more information on this, see Quota and limits.

Activity Log Record Structure

Each activity log record contains the following information:

URI: URI of the activity log record; the log record may be requested by the URI
user: ID of a user who performed activity
timestamp: time when the activity occurred
label: short description of the activity
description: detailed description of the activity
items: list of items affected by the activity
itemsCursor: if the attribute is present this means that the items array does not contain all items of the Activity Log record, you may request REST items using this cursor

Each activity log item contains the following information:

id: unique ID of the item
method: HTTP method used in the Rest API request
url: HTTP URL of the REST API request
clientType: type of client who made the REST API request. Clients may specify own type via globalId: HTTP header; in case the header is not specified, the type is UNKNOWN
objectUri: URI of an affected object (if any)
objectType: type of an affected object (if any)
objectLabel: label of an affected object (if any)
startObjectUri: URI of start object for relationship (for RELATIONSHIP_* events) (if any)
startObjectLabel: label of start object for relationship (for RELATIONSHIP_* events) (if any)
endObjectUri: URI of end object for relationship (for RELATIONSHIP_* events) (if any)
endObjectLabel: label of end object for relationship (for RELATIONSHIP_* events) (if any)
timestamp: time when the object was affected
data: information about type of affect on the object
data.type possible values are:
- ENTITY_CREATED
- ENTITY_REMOVED
- ENTITY_LOST_MERGE
- ENTITY_CHANGED
- ENTITIES_SPLITTED
- ENTITIES_CATEGORY_TREE_STRUCTURE_CHANGED
- ENTITY_UPDATED
- ENTITIES_MERGED
- ENTITIES_MERGED_MANUALLY
- ENTITIES_MERGED_ON_THE_FLY
- RELATIONSHIP_CREATED
- RELATIONSHIP_REMOVED
- RELATIONSHIP_CHANGED
- RELATION_LOST_MERGE
- INTERACTION_CHANGED
- CHANGE_REQUEST_CREATED
- CHANGE_REQUEST_CHANGED
- CHANGE_REQUEST_REMOVED
- LOOKUPS_CHANGED
- LOOKUPS_REMOVED
- POTENTIAL_MATCHES_FOUND
- POTENTIAL_MATCHES_REMOVED
- AS_MATCHES_SET
- NOT_MATCHES_SET
- AS_MATCHES_RESET
- NOT_MATCHES_RESET
- MODEL_UPDATED
- TENANT_UPDATED
- TENANT_RECREATED
- PERIODIC_TASK_SCHEDULED
- PERMISSIONS_UPDATED
- SEARCH_REQUESTS_CREATED
- SEARCH_REQUESTS_UPDATED
- SEARCH_REQUESTS_REMOVED
deltaCollection: list of changed attributes of the object (also contains source systems with which changed attributes were associated)

Activity Log Record

{
   "user":"user1",
   "label":"",
   "description":"",
   "timestamp":1427811381983,
   "items":[
      {
         "id":"06dm6Ne",
         "method":"POST",
         "url":"/reltio/api/activity/entities",
         "clientType":"Reltio UI",
         "objectUri":"relations/5pVeqm2",
         "objectType":"configuration/relationTypes/HasAddress",
         "startObjectUri":"entities/5pfz3pK",
         "startObjectLabel":"John Smith",
         "endObjectUri":"entities/5pfzGc6",
         "endObjectLabel":"Palo Alto, 3309 El Camino Real",
         "timestamp":1427811381983,
         "data":{
            "type":"RELATIONSHIP_REMOVED"
         }
      },
      {
         "id":"06dlpKc",
         "method":"POST",
         "url":"/reltio/api/activity/entities",
         "clientType":"Reltio UI",
         "objectUri":"entities/5pfzGc6",
         "objectType":"configuration/entityTypes/Location",
         "objectLabel":"Palo Alto, 3309 El Camino Real",
         "timestamp":1427811381983,
         "data":{
            "type":"ENTITY_CHANGED"
         },
         "deltaCollection":{
            "ovChanged":true,
            "delta":[
               {
                  "type":"ATTRIBUTE_REMOVED",
                  "attributeType":"configuration/entityTypes/Location/attributes/Zip/attributes/Zip4",
                  "oldValue":{
                     "value":"9999",
                     "ov":true,
                     "id":"1ApuCUz4",
                     "sources":[
                        "LNKD"
                     ]
                  }
               },
               {
                  "type":"ATTRIBUTE_CHANGED",
                  "attributeType":"configuration/entityTypes/Location/attributes/City",
                  "newValue":{
                     "value":"TestCityEd",
                     "ov":true,
                     "id":"1ApuHvhS",
                     "sources":[
                        "LNKD"
                     ]
                  },
                  "oldValue":{
                     "value":"TestCity",
                     "ov":true,
                     "id":"1ApuCDw2",
                     "sources":[
                        "LNKD"
                     ]
                  }
               }
            ]
         }
      },
      {
         "id":"06dm27O",
         "method":"POST",
         "url":"/reltio/api/activity/entities",
         "clientType":"Reltio UI",
         "objectUri":"relations/5pVeiFW",
         "objectType":"configuration/relationTypes/Employment",
         "startObjectUri":"entities/5pfz3pK",
         "startObjectLabel":"John Smith",
         "endObjectUri":"entities/5pfzGc7",
         "endObjectLabel":"Joe Smith",
         "timestamp":1427811381983,
         "data":{
            "type":"RELATIONSHIP_REMOVED"
         }
      },
      {
         "id":"06dmAdu",
         "method":"POST",
         "url":"/reltio/api/activity/entities",
         "clientType":"Reltio UI",
         "objectUri":"entities/5pfz3pK",
         "objectType":"configuration/entityTypes/HCP",
         "objectLabel":"John Smith",
         "timestamp":1427811381983,
         "data":{
            "type":"ENTITY_CHANGED"
         },
         "deltaCollection":{
            "ovChanged":true,
            "delta":[
               {
                  "type":"ATTRIBUTE_CHANGED",
                  "attributeType":"configuration/relationTypes/HasAddress/attributes/ExternalID",
                  "newValue":{
                     "value":"id1Ed",
                     "ov":true,
                     "id":"1ApuICkU",
                     "sources":[
                        "LNKD"
                     ]
                  },
                  "oldValue":{
                     "value":"id1",
                     "ov":true,
                     "id":"1ApuCuYc",
                     "sources":[
                        "LNKD"
                     ]
                  }
               },
               {
                  "type":"ATTRIBUTE_CHANGED",
                  "attributeType":"configuration/relationTypes/HasAddress/attributes/AddressRank",
                  "newValue":{
                     "value":"122",
                     "ov":true,
                     "id":"1ApuI4Dy",
                     "sources":[
                        "LNKD"
                     ]
                  },
                  "oldValue":{
                     "value":"1",
                     "ov":true,
                     "id":"1ApuCyos",
                     "sources":[
                        "LNKD"
                     ]
                  }
               },
               {
                  "type":"ATTRIBUTE_REMOVED",
                  "attributeType":"configuration/entityTypes/Location/attributes/Zip/attributes/Zip4",
                  "oldValue":{
                     "value":"9999",
                     "ov":true,
                     "id":"1ApuCUz4",
                     "sources":[
                        "LNKD"
                     ]
                  }
               },
               {
                  "type":"ATTRIBUTE_CHANGED",
                  "attributeType":"configuration/entityTypes/Location/attributes/City",
                  "newValue":{
                     "value":"TestCityEd",
                     "ov":true,
                     "id":"1ApuHvhS",
                     "sources":[
                        "LNKD"
                     ]
                  },
                  "oldValue":{
                     "value":"TestCity",
                     "ov":true,
                     "id":"1ApuCDw2",
                     "sources":[
                        "LNKD"
                     ]
                  }
               },
               {
                  "type":"ATTRIBUTE_REMOVED",
                  "attributeType":"configuration/entityTypes/HCP/attributes/Address",
                  "oldValue":{
                     "value":{
                        "AddressRank":[
                           {
                              "value":"1",
                              "ov":true,
                              "id":"1ApuDK8A",
                              "sources":[
                                 "LNKD"
                              ]
                           }
                        ],
                        "AddressLine1":[
                           {
                              "value":"TestAddress2",
                              "ov":true,
                              "id":"1ApuD7LO",
                              "sources":[
                                 "LNKD"
                              ]
                           }
                        ],
                        "City":[
                           {
                              "value":"TestCity",
                              "ov":true,
                              "id":"1ApuDBbe",
                              "sources":[
                                 "LNKD"
                              ]
                           }
                        ]
                     },
                     "ov":true,
                     "id":"5pVeqm2",
                     "sources":[
                        "LNKD"
                     ]
                  }
               }
            ]
         }
      },
      {
         "id":"06dlxr8",
         "method":"POST",
         "url":"/reltio/api/activity/entities",
         "clientType":"Reltio UI",
         "objectUri":"relations/5pVemVm",
         "objectType":"configuration/relationTypes/HasAddress",
         "startObjectUri":"entities/5pfz3pK",
         "startObjectLabel":"John Smith",
         "endObjectUri":"entities/5pfzGc6",
         "endObjectLabel":"Palo Alto, 3309 El Camino Real",
         "timestamp":1427811381983,
         "data":{
            "type":"RELATIONSHIP_CHANGED"
         },
         "deltaCollection":{
            "ovChanged":true,
            "delta":[
               {
                  "type":"ATTRIBUTE_CHANGED",
                  "attributeType":"configuration/relationTypes/HasAddress/attributes/ExternalID",
                  "newValue":{
                     "value":"id1Ed",
                     "ov":true,
                     "id":"1ApuICkU",
                     "sources":[
                        "LNKD"
                     ]
                  },
                  "oldValue":{
                     "value":"id1",
                     "ov":true,
                     "id":"1ApuCuYc",
                     "sources":[
                        "LNKD"
                     ]
                  }
               },
               {
                  "type":"ATTRIBUTE_CHANGED",
                  "attributeType":"configuration/relationTypes/HasAddress/attributes/AddressRank",
                  "newValue":{
                     "value":"122",
                     "ov":true,
                     "id":"1ApuI4Dy",
                     "sources":[
                        "LNKD"
                     ]
                  },
                  "oldValue":{
                     "value":"1",
                     "ov":true,
                     "id":"1ApuCyos",
                     "sources":[
                        "LNKD"
                     ]
                  }
               }
            ]
         }
      }
   ],
   "URI":"activities/ed68ca34-6b59-4687-a557-bdefc9ec2f4b"
}

Accelerate the Value of Data

Search using Activity Log API

Returning Activity Log Data

Activity Log Record Structure

Activity Log Record

Footer