Findsi API documentation
Findsi API documentation
| Method | GET |
| Rel | findsi:targets |
| Description | Returns a paged list of Targets the requesting API consumer has logged activities for. |
| Required | Description | |
| filter | No | A filter to apply on on the result set. Targets can be filtered by their Classification (exact match). |
| page_index | No | 0-based index of the requested result set. |
A successful response (HTTP 200) will be a HAL document, containing the following:
Only the default _self and curies links will be included.
| Type | Description | |
| target | Targets that the requesting API consumer has logged at least one activity for. |
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 /targets 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 1077
Content-Type application/hal+json; charset=utf-8
Date Thu, 11 Sep 2014 16:57:01 GMT
Expires -1
Pragma no-cache
{
"_links": {
"curies": {
"href": "http://www.findsi.com/docs/link-relations/{rel}",
"templated": true,
"name": "findsi"
},
"self": {
"href": "/targets?page_index=0"
}
},
"_embedded": {
"findsi:target": [
{
"Id": "3722387",
"Classification": "article",
"_links": {
"findsi:targets": {
"href": "/targets"
},
"self": {
"href": "/targets/..."
}
}
},
{
"Id": "3717318",
"Classification": "article",
"_links": {
"findsi:targets": {
"href": "/targets"
},
"self": {
"href": "/targets/..."
}
}
},
{
"Id": "3716660",
"Classification": "article",
"_links": {
"findsi:targets": {
"href": "/targets"
},
"self": {
"href": "/targets/..."
}
}
}
]
}
}