A
A
API
Search…
Get

Search our index and retrieve a list of documents

Parameters:

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, ...)

Demo

URL Find your token on - yumpu.com Token
q

Optional parameters:

in op offset limit return_fields sort language pages views create_date category
Add optional parametersRun request
1
Copied!
curl
PHP
JavaScript
Java
Example:
1
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://search.yumpu.com/2.0/search.json?q=s.moser&in=author"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$data = array(
4
'q' => 's.moser',
5
'in' => 'author'
6
);
7
$search = $yumpu->search($data);
8
print_r($search);
9
?>
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = '{
4
q: 's.moser',
5
in: 'author'
6
}';
7
yumpu.search(parameters, function(statusCode, document){
8
console.log('Status: ' + statusCode);
9
console.log(document);
10
});
Copied!
Example:
1
Yumpu y = new Yumpu("your access token");
2
String[] params = {"q=s.moser", "in=author"};
3
System.out.println(y.search(params));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
"total": 813,
3
"documents": [
4
{
5
"id": "42025",
6
"url": "http://www.yumpu.com/en/document/view/42025/google-eric-schmidt-at-the-milken-institute-global-conference",
7
"short_url": "http://www.yumpu.com/s/iMWmtU3n9y8d8gup",
8
"image": {
9
"small": "http://images001.yumpu.com/yumpu.com/5647/1335778383_6815/thumb/page000001.jpg",
10
"medium": "http://images001.yumpu.com/yumpu.com/5647/1335778383_6815/small/page000001.jpg",
11
"big": "http://images001.yumpu.com/yumpu.com/5647/1335778383_6815/zoom/page000001.jpg"
12
},
13
"language": "en",
14
"title": "Google Eric Schmidt at the Milken Institute Global Conference",
15
"description": "Google Eric Schmidt at the Milken Institute Global Conference",
16
"tags": [
17
"google",
18
"eric",
19
"schmidt",
20
"milken",
21
"institute",
22
"global",
23
"conference",
24
"www.yumpu.com"
25
],
26
"embed_code": "iframe"
27
},
28
{
29
"id": "23231",
30
"url": "http://www.yumpu.com/en/document/view/23231/vw-collision-repair-facilities-list-1121",
31
"short_url": "http://www.yumpu.com/s/VGWt63UNawxMH13U",
32
"image": {
33
"small": "http://images001.yumpu.com/yumpu.com/4038/1335447967_952/thumb/page000001.jpg",
34
"medium": "http://images001.yumpu.com/yumpu.com/4038/1335447967_952/small/page000001.jpg",
35
"big": "http://images001.yumpu.com/yumpu.com/4038/1335447967_952/zoom/page000001.jpg"
36
},
37
"language": "en",
38
"title": "VW Collision Repair Facilities List 11.21",
39
"description": "VW Collision Repair Facilities List 11.21",
40
"tags": [
41
"collision",
42
"body",
43
"center",
44
"auto",
45
"shop",
46
"avenue",
47
"street",
48
"repair",
49
"none",
50
"paint",
51
"facilities",
52
"list",
53
"www.yumpu.com"
54
],
55
"embed_code": "iframe"
56
},
57
{
58
...
59
}
60
],
61
"state": "success"
62
}
Copied!
Last modified 1yr ago