Circle Matcher is a resource that allows you to validate if your circles are in coherent segmentations. You can also use it in your applications to determine in which circle your users fit better.
{% hint style="info" %} One good practice is to always make this identification when a user logs in the application. However, this can be changed according to your business needs. {% endhint %}
Once you start using the interface, it's possible to notice that there are two ways to perform the circle identification. For that, access the Circles menu inside a workspace and select the icon indicated below:
The two ways to make this validation are:
- Default: in this option, you add manually keys and values to define the characteristics of a user test. And, based on that, once you execute the Try, you will receive all the circles related to these user.
- JSON: similar to the default option, with the difference that here you can copy and paste in payload field a JSON of your productive environment instead of adding manually.
{% hint style="warning" %} If you pass some information that are off the preconfigured logic conditions in the circles, the system will return indicating that the user is on Default circle, on the standard version of your application. {% endhint %}
You can integrate in your applications the Identify resource on the charles-circle-matcher module to detect the circles the user belongs to.
For example, considering the use of the parameters below to segment:
Once you send the identification request with some information, compatible circles will be returned.
{% api-method method="post" host="https:" path="//api.charles-moove.com/identify" %} {% api-method-summary %} Identify {% endapi-method-summary %}
{% api-method-description %} Method used to identify circles based on the user's characteristics {% endapi-method-description %}
{% api-method-spec %} {% api-method-request %} {% api-method-body-parameters %} {% api-method-parameter name="requestData" type="object" required=false %} { "state": "NY", "profession": "Lawyer", "age": 46, "city": "Stony Brook" {% endapi-method-parameter %}
{% api-method-parameter name="workspaceId" type="string" required=false %} UUID {% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %}
{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}
{% endapi-method-response-example-description %}
{
"circles": [
{
"id": "6577ae92-648c-11ea-bc55-0242ac130003",
"name": "NY Lawyers"
},
{
"id": "6577b112-648c-11ea-bc55-0242ac130003",
"name": "Stony Brook's Citizens"
}
]
}
{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}
As the example above shows, there are correspondents circles with the given informations of the user, which means that charlescd-circle-matcher will return a list with all the circles. Here, there are two circles that fit with this description: NY Lawyers e Stony Brook’s Citizens.
In this request, only the parameter X-Workspace-Id is mandatory. The requisition body is totally flexible, but it's good to remember that the keys must have the same nomenclature defined by segmentation's rules of the circle. Let's see the case below:
The Stony Brook’s Citizens circle was created to identify users that contains as one of its characteristics the key city and the exact value Stony Brook. That means that this user won't be listed if you send a request to Identify and inform on the requisition body the information presented on the example below:
{% api-method method="post" host="https:// api.charlescd-circle-matcher.com/identify " path="" %} {% api-method-summary %} Identify {% endapi-method-summary %}
{% api-method-description %}
{% endapi-method-description %}
{% api-method-spec %} {% api-method-request %} {% api-method-body-parameters %} {% api-method-parameter name="requestData" type="object" required=false %} {"aGEee": 46, "city": "Stony Brook"} {% endapi-method-parameter %}
{% api-method-parameter name="workspaceId" type="string" required=false %} UUID {% endapi-method-parameter %} {% endapi-method-body-parameters %} {% endapi-method-request %}
{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} List of all circle the users belong to {% endapi-method-response-example-description %}
{
"circles": [
{
"id": "6577ae92-648c-11ea-bc55-0242ac130003",
"name": "Default"
}
]
}
{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}