Get
Retrieve an existing hotspot
Parameters:
Name
Optional / Required
Data type
Description
Default
id
required
String
One of your document hotspot ids
return_fields
optional
String
Customize the responses by setting the return fields (id, document_id, page, type, settings, create_date, update_date)
id, document_id, page, type, settings, create_date, update_date
Demo
URL Find your token on - yumpu.com Token
id
Optional parameters:
return_fields
Add optional parametersRun request
Example:
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://api.yumpu.com/2.0/document/hotspot.json?id=18414788HxIRKIoB"
Whatever language you are using, the result will be the same.
{
"hotspot": [
{
"id": "18414788HxIRKIoB",
"document_id": "27109085",
"page": "1",
"type": "link",
"settings": {
"x": "0",
"y": "0",
"w": "400",
"h": "100",
"name": "www.yumpu.com",
"tooltip": "www.yumpu.com",
"link": "https://www.google.com"
},
"create_date": "2014-09-23 07:17:39",
"update_date": "2014-09-23 07:20:21"
}
],
"state": "success",
"completed_in": "0.1853"
}
Last updated
Was this helpful?