Vizzlo’s portfolio is the full set of all available Vizzards (chart types). Vizzards are usually navigated to through multiple lists. See for example this portfolio content (that only contains five vizzards for demonstration purposes):
That same five Vizzards might be show up in multiple spots throughout the portfolio:
To be able to build this kind of structured UI, use the following API calls.
GET /api/v1/portfolio
GET /api/v1/portfolio/
id
GET /api/v1/portfolio/search
This endpoint is used to search the portfolio for certain user-specified keywords.
The JSON will contain the actual search terms as query
as well as optional paging information.
The search request is submitted using the following query parameters:
query
(string): User-specified search terms to search for.limit
(number): Optional: Maximum number of search results to return. (Default: 100
)offset
(number): Optional: Offset of the first search result matching the query to return. (Default: 0
)include_description
(boolean): Optional: Return a list of Vizzard descriptions instead of just Vizzards IDs.query
(string): The search query used by this request.limit
(number): Maximum number of search results to return.offset
(number): Offset of the first search result matching the query to return.count
(number): Total number of search results available matching query
.ids
(array of strings): Ordered list of Vizzards matching query
. This key will not be returned, if include_description
was true
.vizzards
(array of objects): Ordered list of Vizzard descriptions matching query
. This key will only be returned, if include_description
was true
.GET /api/v1/vizzards/
id
{
// …
}
POST /api/v1/vizzards/
id
/reviews
Review shall be posted as JSON document with the following keys:
rating
(number): 1–5 stars.feedback
(string): Written review.public
(boolean): true
if this review shall be posted on the site.Marks the Vizzard specified by id
as a favorite.
PUT /api/v1/portfolio/favorites/
id
Returns a JSON array of strings containing the now current list of favorites.
If currently a favorite, removes the Vizzard specified by id
from the list of favorites.
DELETE /api/v1/portfolio/favorites/
id
Returns a JSON array of strings containing the now current list of favorites.