Simple Search API

This page describes a proposed flow-library query API.

GET /api/v1/search

Search for nodes and flow gists that match query parameters

Parameters

The following query parameters are supported.

Parameter	Type	Description	Default Value
term	string	text to search for in name, description and other fields	(empty)
page	integer	page to show (starting with page 1)	1
per_page	integer	number of things to show per page	18
num_pages	integer	number of pages to retrieve	1
view	full|summary|counts	full - return all information, summary - only summary information, counts - total number of things and count that match query	full
type	flow|node|all	show flows or nodes, or both	all
sort	recent|rating|downloads	sort in descending order by recently added, user rating, or weekly downloads	recent

Response

Status Code	Reason	Response
200	Success	response object containing count, total, and list of things that match query (if summary or full view used)

Example

{
    "total":1348,
    "count":1348,
    "things":[
        {"_id":"f40d8bfb37e975ac7c622e4eec6b0a0f","updated_at":"2018-02-06T20:31:19Z","type":"flow"},
        {    "_id":"node-red-contrib-firebase",
            "name":"node-red-contrib-firebase",
            "dist-tags":{"latest":"1.1.1"},
            "type":"node",
            "updated_at":"2018-02-06T18:31:30.930Z",
            "rating":{"score":4,"count":1},
            "downloads":{"day":23,"week":234,"month":850}},
            ...
         },
         ...
    ]
}