Updates login app clustering rules

Deprecated

https://api.socialidnow.com/v1

PUT

/marketing/login/apps/clustering/rules

Updates login app clustering rules.

When a user logs in using his credential, these rules will be evaluated by the clustering engine, which will determine the likelihood for each feature label, according to the classifier used to evaluate the feature.

For example, the feature could be "music", and the labels could be "rock", "pop" and "blues". The clustering engine goal is to determine the user's interest likelihood for each label from a given feature. Considering the previous example, an example of likelihoods could be: rock - 0.5, pop - 0.2, blues - 0.3, that is, the user seems to be more interested on "rock" music, with 50% probability.

The clustering results for each user can be retrieved using the API GET login/users/:user_id/clustering/features.

⚠️ Deprecation notice: this feature is deprecated since December 31, 2024.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

OK. The request was successful.

This response does not have a body.

🟠401Unauthorized

🟠422Parameter Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.socialidnow.com/v1/marketing/login/apps/clustering/rules' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rules": {
        "features": {
            "music": {
                "labels": [
                    {
                        "name": "rock",
                        "keywords": [
                            "rock"
                        ]
                    },
                    {
                        "name": "pop",
                        "keywords": [
                            "pop"
                        ]
                    },
                    {
                        "name": "blues",
                        "keywords": [
                            "blues"
                        ]
                    },
                    {
                        "name": "country",
                        "keywords": [
                            "country"
                        ]
                    }
                ],
                "classifier": {
                    "type": "likes",
                    "categories": [
                        "Musician/Band",
                        "Music",
                        "Music award"
                    ],
                    "threshold": 0.1,
                    "excluded_words": [
                        "soul"
                    ]
                }
            },
            "movies": {
                "labels": [
                    {
                        "name": "drama",
                        "keywords": [
                            "drama"
                        ]
                    },
                    {
                        "name": "comedy",
                        "keywords": [
                            "comedy",
                            "comedia"
                        ]
                    },
                    {
                        "name": "sci-fi",
                        "keywords": [
                            "sci-fi",
                            "scifi"
                        ]
                    },
                    {
                        "name": "horror",
                        "keywords": [
                            "horror",
                            "terror"
                        ]
                    },
                    {
                        "name": "adventure",
                        "keywords": [
                            "adventure",
                            "aventura"
                        ]
                    }
                ],
                "classifier": {
                    "type": "likes",
                    "categories": [
                        "Movie",
                        "Movie genre",
                        "Movies/music"
                    ],
                    "threshold": 0
                }
            }
        },
        "parameters": {
            "excluded_words": [
                "hate",
                "bad",
                "ugly"
            ]
        }
    }
}'

Response Example

401 - Example 1

{
    "error": "authentication_failed",
    "error_description": "string",
    "errors": [
        "string"
    ]
}

Modified at 2025-08-19 19:08:55

Returns login app clustering rules

Trigger an event for a Login App user