Add analytic attribute value for a relation

Learn how to add analytic attribute values for a relation.

This API operation enables you to add an analytic attribute for a relation of an entity.

Note: The analytic attribute APIs work only if you enable analytics for the tenant in the physical tenant configuration, as shown here:

 "analyticsConfig": {
        "analyticsEnabled": true,
}

Request

POST {TenantURL}/relations/{objectId}/_analyticsAttributes


Parameter		Required	Description
Headers	`Authorization`	Yes	Information about authentication access token in the format "Bearer `<accessToken>`". For more information, see Authentication API.
Query	returnObjects	No	Denotes if the response must contain created relations. This field defaults to `true`.
Body		Yes	JSON object specifying the different analytic attributes.

Response

An array with results for each element of a request, which will contain the following properties:

index - The index of the relation object in JSON array of the relations to be created. This is mandatory.
uri - The URI of the relation object that is created. This is returned only if the object is successfully created.
object - The relation object that is updated. This parameter is returned only if the returnObjects query parameter in the request is true and the object was successfully created.

Note: By default, hidden attributes are not included in the response. To include hidden attributes, add the options=sendHidden parameter in the request.
error - The details of the error when the object is not created, which can be one of the following:
- warning - if the object is created but with some problems.
- status - result of the operation, which can be OK or failed.

Example - Request

POST {{tenantURL}}/relations/0dSgHH4/_analyticsAttributes
{
         "EnvHealthScore":{
            "value":"77"
        }
    }

Response

{
    "index": 0,
    "object": {
        "uri": "relations/0dSgHH4",
        "type": "configuration/relationTypes/OrganizationHasAddress",
        "createdBy": "abhradeep.sengupta@reltio.com",
        "createdTime": 1747731996603,
        "updatedBy": "abhradeep.sengupta@reltio.com",
        "updatedTime": 1747731996603,
        "startRefPinned": false,
        "startRefIgnored": false,
        "endRefPinned": false,
        "endRefIgnored": false,
        "attributes": {},
        "analyticsAttributes": {
            "EnvHealthScore": [
                {
                    "type": "configuration/relationTypes/OrganizationHasAddress/analyticsAttributes/EnvHealthScore",
                    "value": "77",
                    "uri": "relations/0dSgHH4/analyticsAttributes/EnvHealthScore/0"
                }
            ]
        },
        "crosswalks": [
            {
                "uri": "relations/0dSgHH4/crosswalks/5X25CeSU",
                "type": "configuration/sources/Reltio",
                "value": "0dSgHH4",
                "reltioLoadDate": "2025-05-20T09:06:36.603Z",
                "createDate": "2025-05-20T09:06:36.603Z",
                "updateDate": "2025-05-20T09:06:36.603Z",
                "attributes": [],
                "singleAttributeUpdateDates": {}
            }
        ],
        "startObject": {
            "objectURI": "entities/1SE4uyTp",
            "crosswalks": [
                {
                    "uri": "entities/1SE4uyTp/crosswalks/4JZ2krE8m",
                    "type": "configuration/sources/Reltio",
                    "value": "1SE4uyTp"
                }
            ]
        },
        "endObject": {
            "objectURI": "entities/01mqaTI",
            "crosswalks": [
                {
                    "uri": "entities/01mqaTI/crosswalks/6s26OWO",
                    "type": "configuration/sources/Reltio",
                    "value": "01mqaTI"
                }
            ]
        }
    },
    "successful": true
}

Unify and manage your data

Add analytic attribute value for a relation

Request

Response

Footer