Get
Name | Optional / Required | Data type | Description | Default |
q | required | String | A keyword to search for | |
in | optinal | String | Search keyword in fields author, title, description or tags | author, title, description, tags |
op | optional | String | Search keyword with "and" or "or" operator | or |
offset | optional | Integer | Retrieve rows at position X (min. 0) | 0 |
limit | optional | Integer | Retrieve X rows (min. 0 and max. 100) | 10 |
return_fields | optional | String | Customize the responses by setting the return fields (id, url, short_url, image_small, image_medium, image_big, language, title, description, tags, embed_code) | id, url, short_url, image_small, image_medium, image_big, language, title, description, tags, embed_code |
sort | optional | String | Sort results (views_desc, views_asc, create_date_desc, create_date_asc, pages_desc, pages_asc) | |
language | optional | String | Filter result (de, en, ...) | |
pages | optional | String or integer | Filter result from 10 to 20 pages (10-20) or exact 30 pages (30) | |
views | optional | String or integer | Filter result with 500 to 1000 views (500-1000) or exact 800 views (800) | |
create_date | optional | String | Filter result which got created from 2013-09-01 between 2013-09-30 (2013-09-01-2013-09-30) or on an exact date 2013-09-01 (2013-09-01) | |
category | optional | Integer | Filter result (1, 2, ...) | |
q
in op offset limit return_fields sort language pages views create_date category
Add optional parametersRun request
curl
PHP
JavaScript
Java
Example:
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://search.yumpu.com/2.0/search.json?q=s.moser&in=author"
Example:
require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
'q' => 's.moser',
'in' => 'author'
);
$search = $yumpu->search($data);
print_r($search);
?>
Example:
var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = '{
q: 's.moser',
in: 'author'
}';
yumpu.search(parameters, function(statusCode, document){
console.log('Status: ' + statusCode);
console.log(document);
});
Example:
Yumpu y = new Yumpu("your access token");
String[] params = {"q=s.moser", "in=author"};
System.out.println(y.search(params));
Whatever language you are using, the result will be the same.
{
"total": 813,
"documents": [
{
"id": "42025",
"url": "https://www.yumpu.com/en/document/view/42025/google-eric-schmidt-at-the-milken-institute-global-conference",
"short_url": "https://www.yumpu.com/s/iMWmtU3n9y8d8gup",
"image": {
"small": "https://images001.yumpu.com/yumpu.com/5647/1335778383_6815/thumb/page000001.jpg",
"medium": "https://images001.yumpu.com/yumpu.com/5647/1335778383_6815/small/page000001.jpg",
"big": "https://images001.yumpu.com/yumpu.com/5647/1335778383_6815/zoom/page000001.jpg"
},
"language": "en",
"title": "Google Eric Schmidt at the Milken Institute Global Conference",
"description": "Google Eric Schmidt at the Milken Institute Global Conference",
"tags": [
"google",
"eric",
"schmidt",
"milken",
"institute",
"global",
"conference",
"www.yumpu.com"
],
"embed_code": "iframe"
},
{
"id": "23231",
"url": "https://www.yumpu.com/en/document/view/23231/vw-collision-repair-facilities-list-1121",
"short_url": "https://www.yumpu.com/s/VGWt63UNawxMH13U",
"image": {
"small": "https://images001.yumpu.com/yumpu.com/4038/1335447967_952/thumb/page000001.jpg",
"medium": "https://images001.yumpu.com/yumpu.com/4038/1335447967_952/small/page000001.jpg",
"big": "https://images001.yumpu.com/yumpu.com/4038/1335447967_952/zoom/page000001.jpg"
},
"language": "en",
"title": "VW Collision Repair Facilities List 11.21",
"description": "VW Collision Repair Facilities List 11.21",
"tags": [
"collision",
"body",
"center",
"auto",
"shop",
"avenue",
"street",
"repair",
"none",
"paint",
"facilities",
"list",
"www.yumpu.com"
],
"embed_code": "iframe"
},
{
...
}
],
"state": "success"
}
Last modified 1yr ago