Findsi API documentation
Findsi API documentation
| Method | GET |
| Rel | findsi:actor-similars |
| Description | Returns a list of Actors that are deemed similar to the given Actor. |
| Required | Description | |
| filter | No | A filter to apply on on the result set. Actors can be filtered by their Classification (exact match). |
A successful response (HTTP 200) will be a HAL document, containing the following:
Besides the default _self and curies links, the following links will be included:
| actors | Returns a paged list of Actors the requesting API consumer has logged activities for. |
| actor-targets | Returns a paged list of Targets, the given Actor has interacted with. |
| actor | Returns the Actor that is the context for this request. |
| Type | Description | |
| actor | Array | Ranked Actors that are deemed similar to the given Actor. |
None
The API may respond with one of the following errors:
| 401 | Unauthorized | The Authorization header might be missing or malformed. Alternatively you may have provided an invalid API key. |
A basic, unfiltered request would look something like:
GET /actors/.../similars HTTP/1.1
Host: api.findsi.com
Accept: application/hal+json
Authorization: findsi_api_key apikey="..."
Content-Type: application/json
Cache-Control: no-cache
If all went well, your response will look something like this:
Cache-Control no-cache
Content-Length 4340
Content-Type application/hal+json; charset=utf-8
Date Thu, 11 Sep 2014 16:17:36 GMT
Expires -1
Pragma no-cache
{
"_links": {
"curies": {
"href": "http://www.findsi.com/docs/link-relations/{rel}",
"templated": true,
"name": "findsi"
},
"findsi:actors": {
"href": "/actors"
},
"findsi:actor-targets": {
"href": "/actors/.../targets"
},
"findsi:actor": {
"href": "/actors/..."
},
"self": {
"href": "/actors/.../similars"
}
},
"_embedded": {
"findsi:actor": [
{
"Rank": 1,
"Id": "456",
"Classification": "user",
"_links": {
"findsi:actors": {
"href": "/actors"
},
"findsi:actor-targets": {
"href": "/actors/.../targets"
},
"findsi:actor-similars": {
"href": "/actors/.../similars"
},
"self": {
"href": "/actors/..."
}
}
},
{
"Rank": 2,
"Id": "789",
"Classification": "subscriber",
"_links": {
"findsi:actors": {
"href": "/actors"
},
"findsi:actor-targets": {
"href": "/actors/.../targets"
},
"findsi:actor-similars": {
"href": "/actors/.../similars"
},
"self": {
"href": "/actors/..."
}
}
},
{
"Rank": 3,
"Id": "123",
"Classification": "user",
"_links": {
"findsi:actors": {
"href": "/actors"
},
"findsi:actor-targets": {
"href": "/actors/.../targets"
},
"findsi:actor-similars": {
"href": "/actors/.../similars"
},
"self": {
"href": "/actors/..."
}
}
}
]
}
}
Note that an special Rank property is added to the Actors, indicating the level of similarity to the given Actor.