A
A
API
Search…
Get

Retrieve a list of your hotspots

Parameters:

Name
Optional / Required
Data type
Description
Default
id
required
Integer
One of your document ids
page
optional
Integer
Filter the results by page nr (1 - X)
offset
optional
Integer
Retrieve rows at position X (min. 0)
0
limit
optional
Integer
Retrieve X rows (min. 0 and max. 100)
10
sort
optional
String
Sort results by create_date_desc, create_date_asc, page_desc, page_asc
page_asc
return_fields
optional
String
Customize the responses by setting the return fields (id, page, type, settings, create_date, update_date)
id, page, type, settings, create_date, update_date

Demo

URL Find your token on - yumpu.com Token
document id

Optional parameters:

page offset limit sort return_fields
Add optional parametersRun request
1
Copied!
curl
PHP
JavaScript
Java
Example:
1
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "http://api.yumpu.com/2.0/document/hotspots.json?id=27109037&limit=1"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$data = array(
4
'id' => 27109085,
5
'limit' => 1
6
);
7
$listHotspots = $yumpu->getDocumentHotspots($data);
8
print_r($listHotspots);
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = {
4
id: 27109037,
5
offset: 0,
6
limit: 1
7
};
8
yumpu.getDocumentHotspots(parameters, function(statusCode, document){
9
console.log('Status: ' + statusCode);
10
console.log(document);
11
});
Copied!
Example:
1
Yumpu y = new Yumpu("your access token");
2
String[] params = {"id=27109037", "limit=1"};
3
System.out.println(y.getDocumentHotspots(params));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
"total": 74,
3
"hotspots": [
4
{
5
"id": "fc62e52bphzHaVqn",
6
"document_id": 27109037,
7
"page": 1,
8
"type": "link",
9
"settings": {
10
"x": 311,
11
"y": 603,
12
"w": 109,
13
"h": 8,
14
"name": "www.yumpu.com",
15
"link": "https://www.yumpu.com",
16
"tooltip": "www.yumpu.com"
17
},
18
"create_date": "2016-09-13 09:13:19",
19
"update_date": "0000-00-00 00:00:00"
20
}
21
],
22
"state": "success",
23
"completed_in": 0.0922
24
}
Copied!
Last modified 1yr ago