Metadata Ingestion APIsShelf and Feed APIsSubscriber Activity APIs
HomeMetaXShelf and Feed APIsFeed – Filter/search on single tag

Feed – Filter/search on single tag

This API is used to filter out a subset of all the items (VoDs or Series) based on the value of a specific tag.
It returns an array of JSON objects of all the items that meet the filtering criteria.

Sample tags on which filtering can be done are:
category,
title,
genres,
cast,
directors,
storylines,
ageGroup,
qualities,
moods,
details
….
etc.

To call the API, replace the “TAG_NAME” with the name of tag on which to filter (e.g. title) and pass the required value to match.

This API can also be used to create a random shelf based on the tags used for filtering.

Resource URL

GET - /metax/2.1/feed/filter/{TAG_NAME}

Header Paramater

Authorization
required
Bearer Access Token

NOTE: Access Token here refers to the access authorization token.

Form Parameter

srh
required
The search text
orderby
optional
This is one of the Paging Parameters .Titles can be ordered by the values of a particular tag in the filtered items. E.g. if orderby=director is specified, then returned items will be sorted according to the values of their "director" tag. Default value: random)
order
optional
This is one of the Paging Parameters. Possible values: 'desc' or 'asc'. The returned items are ordered in ascending or descending order based on the values for the tag specified in "orderby" parameter. E.g. orderby=director&order=asc will arrange the objects in alphabetically increasing order of the values of the "director" tag. Default value: 'desc'.
limit
optional
This is also one of the Paging Parameters. This controls the maximum number of filtered Items to be returned (as determined by the usecase). A value of 0 means that all items are to be returned. Default value: 0 .
skip
optional
This is one the Paging Parameters. The zero-based identifier of the page to return. Default value 0.
exact
optional
Possible values: true or false. This determines whether the search text (passed in srh parameter), should be fully matched or partial matches should be allowed. Default value: false - So items with tag-values partially matching the search text are returned by default.
device
optional
Type of the device for which the item details should be returned. (e.g. roku, iphone, ipad, android-mobile, android-tab, web etc.) If this value is present, MetaX will return the meta-data specific to that device. (e.g. small thumbnail URLs are returned for mobiles.) Default value: iphone
size
optional
'min' or 'max'. Determines how much information should be provided for each item. Min returns a small subset of tags for each item including Id, Title, Thumbnail. Specifying size='max' returns all tags associated with the item like cast, director, etc. Default value: min

Example Request URL

GET - http://__JTV_HOST__/metax/2.1/feed/filter/title?srh=the&limit=0&orderby=director&order=asc

Example Return

The response of a invalid authorization access call ( Status #401) will look as follows:-

To see how to get access token - (see Getting Access Tokens)

The response of an ERROR in authorization access call ( Status #404) will look as follows:-

HTTP Status 404