Get

Retrieve a list of your hotspots

Parameters:

Name

Optional / Required

Data type

Description

Default

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)

limit

optional

Integer

Retrieve X rows (min. 0 and max. 100)

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

Example:

curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://api.yumpu.com/2.0/document/hotspots.json?id=27109037&limit=1"

Example:

var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
  id: 27109037,
  offset: 0,
  limit: 1
};
yumpu.getDocumentHotspots(parameters, function(statusCode, document){
   console.log('Status: ' + statusCode);
   console.log(document);
});

Whatever language you are using, the result will be the same.

{
  "total": 74,
  "hotspots": [
    {
      "id": "fc62e52bphzHaVqn",
      "document_id": 27109037,
      "page": 1,
      "type": "link",
      "settings": {
        "x": 311,
        "y": 603,
        "w": 109,
        "h": 8,
        "name": "www.yumpu.com",
        "link": "https://www.yumpu.com",
        "tooltip": "www.yumpu.com"
      },
      "create_date": "2016-09-13 09:13:19",
      "update_date": "0000-00-00 00:00:00"
    }
  ],
  "state": "success",
  "completed_in": 0.0922
}

PreviousDocument hotspots NextDocument hotspot

Last updated 3 years ago

Was this helpful?