Search with cursor

The API helps you to search activity logs with a cursor.

This function returns records matching specified criteria in a strictly defined order.

You can disable the creation of object labels from the tenant configuration. For more information, contact Reltio Support (see topic Need some help?).

It works like a cursor in relational databases, where some character sequence is returned to the API user as a response. All consequent requests with this cursor return the next set of data in a defined order.

The following criteria are considered while searching the API Logs with cursor:

In the entire data set that is returned, data must not be repeated.
The cursor value may or may not change during scanning. However, it is essential to pass the most recent cursor to the next API request.
The default cursor Time to Live (TTL) is one day after the last read.
When the preserveCursor is set in tenant configuration, the Persistent cursor TTL is one hour after the last read.
The entire reading session is not time-limited.

By default, the scan API returns results for the last four months only. To extend the time range, you can alternatively use Exporting Activity Log Data.

Request

POST {TenantURL}/activities/_scan

Irrespective of the value that you enter in the filter={Condition Type}(property, value) condition, the search engine considers only the first 256 symbols of the entered value and ignores the rest.

To search an Activity Log with a cursor, use the parameters listed in this table.

Table 1. Parameters to search an Activity Log with a cursor
Name		Required	Details	Examples
Headers	`Authorization`	Yes	Information about authentication access token in format "`Bearer <accessToken>`" (see details in Authentication API).
Query	`filter`	Yes, in first request in sequence (scan request without filter would cause an error).	Enables activities filtering by a condition. For more information, see Filtering activities.	Filter by object type: `filter=(equals(items.objectType,'configuration/entityTypes/Organization'))`
	`max`	No	Positive Integer value to identify maximum number of activities to return in a response. Default value depends on the tenant configuration.	`max=10`
	`sort`	No	Activity objects property that should be used for sorting. Can be used in combination with the `order` parameter to have reverse order. Default sorting is by `timestamp` in descending order.	`sort=user`
	`order`	No	Order of sorting. Can be used in combination with the `sort` parameter to have the reverse order. Possible values: `asc`: results are shown in ascending order `desc`: results are shown in descending order Default sorting is by activity `asc`.	`order=desc`
Request Body	Cursor definition	Yes, for all requests except the first one	JSON object defining the cursor value. Must have one JSON attribute, `cursor`, with the sub-JSON structure having one string attribute `value`.	`{ "cursor" : { "value" : "cXVlcnlBbmRGZXRjaDsxOzE0NDI3OmpzdTdBNGNnUWU2YlBqc1JQbTlNbnc7MDs=" } }`

Response

JSON object with the cursor specification and the response part.

Activities performed on all location entities

Request

{{TenantURL}}/activities/_scan?filter=equals(items.objectType, 'configuration/entityTypes/Location')&max=100

Response

{
   "cursor": {
      "value": "IgKO2crC6EU7d0HEHENtFzhzA1gY1Fkz0G/eC8ruyjXo2RDk7mXwZVapJVjWNi7uVYmTVnJcyA322JZSCr7ff4HsfAu/ozdX6M5LL1F9ZJechTK3OpPVRTKIi6irPkzFzVxfcoZtaa2lWFIwNbl6mPVVxTKtMnOvp5m7TuJTjf5cYaZkTTNg8100l91WTuLyqxfT4FPiRQNcUYtClhhsFGg+XCaY7JDmWQvknOK5QEvxEE/lJtzCpuQFkI8W46ZwiHO/S1w+rGVySt2rbqh6W3HTeO/3FRTXXypfy/j/lXEtXKf7azyzA0fExT+RpYxkL9OjcfsSx+Xg3/P1m7MQZ9u2BePkwktLLNHTde3GMOFe+uyi5L+ffIDEK01WbzOGPx6ZMnfnKJA4kc9n9X+MCW3SDbcv9EkzGIblVmCKW8qG1TcwyEcdi5GHt9ToQivWHwGY9NvJDGxDHirtWyKvdvFFMJgNcsyWvVU/SlBoNRb9sGviq/OiR+iQU0JK0Jh6i16eNqVuUxAmVaz2Okc9ccCnlUg1j2i6dJKndJAJ9pzDi5gdheBVURgDnacCXCtItOhvjrRPAXAuyCk/TOzXWNPm/dQKPNsULueN+n+4J4DTTG4WTBC2jdRDLv555PzRJlYDwMBznRda9ZSDV43O9w=="
   },
   "objects": [
      {
         "id": "4JikNOBa",
         "user": "test_user",
         "clientType": "UNKNOWN",
         "timestamp": 1580967309701,
         "objectUri": "entities/1BoHvzLg",
         "objectType": "configuration/entityTypes/Location",
         "objectLabel": "19 Turquoise Pl CALOUNDRA WEST QLD 4551 Australia",
         "data": {
            "type": "ENTITY_CHANGED"
         },
         "deltaCollection": {
            "ovChanged": true,
            "delta": [
               {
                  "type": "ATTRIBUTE_CHANGED",
                  "attributeType": "configuration/entityTypes/Account/attributes/AccountStatus",
                  "newValue": {
                     "value": "Validated",
                     "ov": false,
                     "id": "2bwP34Ege",
                     "sources": [
                        "Salesforce"
                     ]
                  },
                  "oldValue": {
                     "value": "Validated",
                     "ov": true,
                     "id": "2bwP34Ege",
                     "sources": [
                        "Salesforce"
                     ]
                  }
               },
               {
                  "type": "ATTRIBUTE_ADDED",
                  "attributeType": "configuration/entityTypes/Account/attributes/AccountStatus",
                  "newValue": {
                     "value": "TestSajid",
                     "ov": true,
                     "id": "3PNOvWgL8",
                     "sources": [
                        "Reltio"
                     ]
                  }
               }
            ]
         },
         "eventId": "1580967309701_8N5U6xo",
         "activityLabel": "UpdateAttributesTask 3feb4200-5e47-4811-9356-c72a17b9328c",
         "activityDescription": ""
      },
      {
         "id": "3bR5po2p",
         "user": "qa.reltio.load",
         "method": "POST",
         "url": "/reltio/api/<<TENANT_ID>>/entities/",
         "clientType": "UNKNOWN",
         "timestamp": 1580966142480,
         "objectUri": "entities/1Ep2W0WG",
         "objectType": "configuration/entityTypes/Location",
         "objectLabel": "3040 S Tuskawilla Rd Oviedo FL 32765 United States",
         "data": {
            "type": "ENTITY_CHANGED"
         },
         "deltaCollection": {
            "ovChanged": true,
            "delta": [
               {
                  "type": "ATTRIBUTE_CHANGED",
                  "attributeType": "configuration/entityTypes/Location/attributes/AccountDetails",
                  "newValue": {
                     "ov": true,
                     "id": "wnO2SUC"
                  },
                  "oldValue": {
                     "ov": true,
                     "id": "wnO2SUC"
                  }
               }
            ]
         },
         "eventId": "1580966142480_1RewsoX",
         "activityLabel": "",
         "activityDescription": ""
      }
        ...
        ...
   ]
}

Accelerate the Value of Data

Search with cursor

Request

Response

Activities performed on all location entities

Footer