====== Timeline Search Endpoint ======

This endpoint is used to search within the public timelines.

===== URL =====
http://rest.netvibes.com/timeline/search?query=''query''&format=''format''\\

===== Arguments =====
''query'' (required): the query, in the format described below\\
''format'' (optional): xml, json, rss, atom\\
''limit'' (optional): the number of results to display per page (default is 20, maximum is 100\\
''offset'' (optional): number of results to skip (ie. jump to next page of results)

===== Query format =====

The query string must be URL-encoded.

In order to use multiple criterions in a query, the following operators are at your disposal (+ is the same as a blank character in the URL):
  * + (AND)
  * OR
  * - (NOT)

By default, all query parameters are sent in AND mode.

Advanced use: it's a [[http://lucene.apache.org/java/docs/queryparsersyntax.html|Lucene Query parser]] search.

==== Keywords ====

Many filters can be applied within the query string, using the following keywords:

^  keyword  ^  Description  ^  Sample usage  ^
|  user  |  limit to one user  |  user:''netvibesId''  |
|  followers  |  limit to the followers of a user  |  followers:''netvibesId''  |
|  friendsof  |  limit to the friends of a user  |  friendsof:''netvibesId''  |
|  title  |  search only in the titles of items  |  title:"netvibes rules"  |
|  comment  |  search only in the comment of items  |  comment:"netvibes rules"  |
|  text  |  search in both title and comments\\ this is the default setting, so it's implicit  |  text:"netvibes rules"  |
|  type  |  limit to one kind of item (see below)  |  type:''type''  |

==== Available types ====

Netvibes users can send items to their public timeline tied to multiple types of content. You may want to filter some out (or in).

^  Type  ^  Description  ^
|  status  |  Activity update from the user  |
|  star  |  Web sites that the user has liked  |
|  widget  |  Widgets that the user has liked  |

==== Example of advanced requests ====

  * Retrieve a user's public activities in XML ([[http://rest.netvibes.com/timeline/search?query=user:xavier&format=xml|link]]):\\ ''query=user:xavier&format=xml''

  * Retrieve the 100 latest public activities of a user's friends in JSON ([[http://rest.netvibes.com/timeline/search?query=friendsof:netvibes&format=xml&limit=100|link]]):\\ ''query=friendsof:netvibes&format=xml&limit=100''

  * Retrieve the last 5 starred items from the followers of a user, in RSS format ([[http://rest.netvibes.com/timeline/search?query=friendsof:maurice%20type:star&format=rss&limit=5
|link]]):\\ ''query=followersof:maurice%20type:star&format=rss&limit=5''

  * Retrieve the 20 next-to-10 last status updates from a user's friends, in Atom format ([[http://rest.netvibes.com/timeline/search?query=friendsof:samyz%20type:status&format=atom&limit=20&offset=10|link]]):\\ ''query=friendsof:samyz%20type:status&format=atom&limit=20&offset=10''

  * Retrieve any item mentionning a given word, in RSS ([[http://rest.netvibes.com/timeline/search?query=user:tariqkrim%20netvibes&format=rss|link]]):\\ ''query=user:tariqkrim%20netvibes&format=rss''

  * Retrieve any item from a user's followers, mentionning a given word in its comment part ([[http://rest.netvibes.com/timeline/search?query=followersof:tariqkrim%20netvibes&format=rss|link]]): ''query=followersof:tariqkrim%20netvibes&format=rss''

  *  Retrieve all items that mention a given word in their comment section, from all the followers of a user ([[http://rest.netvibes.com/timeline/search?query=followersof:tariqkrim%20type:status%20comment:netvibes&format=rss
|link]]):\\ ''query=followersof:tariqkrim%20type:status%20comment:netvibes&format=rss''

  *  Retrieve the status for two users ([[http://rest.netvibes.com/timeline/search?query=type:status%20(user:florent%20OR%20user:charles)&format=rss|link]]):\\ ''query=type:status%20(user:florent%20OR%20user:charles)&format=rss''

  * Retrieve starred items that mention one of a few word, for many users ([[http://rest.netvibes.com/timeline/search?query=type:star%20(user:florent%20OR%20user:charles%20OR%20user:znarf)%20(javascript%20OR%20html)&format=rss
|link]]):\\ ''query=type:star%20(user:florent%20OR%20user:charles%20OR%20user:znarf)%20(javascript%20OR%20html)&format=rss''

Etc.

===== Example Request =====

Retrieving all public statuses.

http://rest.netvibes.com/timeline/search?query=type:status

==== XML response ====

<code xml>
<?xml version="1.0" encoding="UTF-8"?>
<netvibes>
  <query>type:status</query>
  <numfound>21118</numfound>
  <timeline>
    <item>
      <id>25116465</id>
        <userId>55028919</userId>
        <type>1</type>
        <createdOn>2008-05-26 22:05:12</createdOn>
        <updatedOn>2008-05-26 22:05:12</updatedOn>
        <data>Bientôt le début des partiels ...</data>
        <comment/>
        <status>public</status>
        <userName>shirase</userName>
        <userFullName>Shirase</userFullName>
    </item>

    <item>
      <id>25115840</id>
      <userId>44865085</userId>
      <type>1</type>
      <createdOn>2008-05-26 21:54:57</createdOn>
      <updatedOn>2008-05-26 21:54:57</updatedOn>
      <data>is very chill at the moment</data>
      <comment/>
      <status>public</status>
      <userName>kewlduud14</userName>
      <userFullName>Bruce K.</userFullName>
    </item>
    (...)
  </timeline>
</netvibes>
<netvibes>
  ...
</netvibes>
</code>