Request and Response Parameters

Request Headers

Header Name	Value
Accept	application/json
Authorization	auth_token

Request Parameters

Property	Presence	Type	Description
query	optional	string	The query string for searching. Queries follow the Lucene query syntax.
types	optional	string	Types of content returned in response. A string with comma separated values is used when querying for more then one type of content. Allowed values asset, category, contentpanel default: asset,category,contentpanel
from	optional	string	The starting index for the search results. default: 0
size	optional	string	The number of results to return in response. default: 25
sortBy	optional	string	Parameter for sorting search results based on a specific attribute. Allowed values: title create-time live-broadcast-time or update-time. default: "" (content sorted by relevance) create-time: timestamp the content was created at update-time: timestamp the content was updated at title: content title live-broadcast-time: only relevant for assets, content sorted by broadcast time
sortOrder	optional	string	The order of sorting, used in combination with sortBy. Allowed values asc desc default: desc asc: sort in ascending order desc: sort in descending order

Success Response Parameters

Property	Type	Property Belongs To	Description
assetTypeName	string	asset	This field would contain the name of the asset type
contentType	string	asset,category,contentpanel	This field defines the type of content
curatedPaths	array	contentpanel	This array consists of several path groups, each represented as an object with a paths array.
contentCreateTime	string	contentpanel	This field contains the timestamp for when the asset’s content was created
contentUpdateTime	string	contentpanel	This field stores the timestamp for the last update to the asset’s content
createTime	string	asset,category,contentpanel	The timestamp indicating when the content was created
duration	integer	asset	An integer representing the asset’s duration
externalSystem	string	asset	A string indicating the external system associated with the asset
externalId	string	asset	A string representing the external identifier of the asset
highlights	object	asset,category,contentpanel	An object containing highlighted search terms, wrapped in vimond-hit tags in the response string (see sample response).
id	string	asset,category,contentpanel	A string representing the unique identifier for this content
imagePack	string	asset,category,contentpanel	This field contains the identifier for an associated image pack
isLiveAsset	boolean	asset	A boolean value, indicating whether the asset is a live asset or not
isParentAsset	boolean	asset	A boolean value, indicating whether this asset serves as a parent asset or not
levelTypeId	integer	category	This field would indicate the level type ID
levelTypeName	string	category	This represents the level type name
listId	string	contentpanel	A string representing the ID of the contentpanel list
liveBroadcastTime	string	asset	A timestamp indicating when the asset will be broadcast live
parentId	string	asset,category	A string that refers to the ID of the parent for this content
publish	array	asset,category,contentpanel	An array indicating the publication status across various platforms: platform: Specifies the platform (e.g., “web”, “app”, “stb”). published: A boolean (false here) indicating that the asset is not yet published on any of these platforms.
titles	object	asset,category,contentpanel	An object containing localized titles of the asset
type	string	asset,category,contentpanel	A string that specifies the type of the entity
updateTime	string	asset,category,contentpanel	The timestamp for when the asset was last updated

Sample Request

curl -X GET \
'https://manage.api.{environment}.vmnd.tv/v1/search?query=%22%27Killers%20Of%20The%20Flower%20Moon%27%22&sortOrder=desc&sortBy=update-time&types=asset%2Ccategory%2Ccontentpanel' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_token>'

Sample Response

{
    "data": [
        {
            "titles": {
                "en_US": "Killers Of The Flower Moon"
            },
            "imagePack": null,
            "publish": [
                {
                    "platform": "web",
                    "published": false
                },
                {
                    "platform": "app",
                    "published": false
                },
                {
                    "platform": "stb",
                    "published": false
                }
            ],
            "type": "asset",
            "id": "960017",
            "levelTypeId": null,
            "levelTypeName": null,
            "highlights": {
                "en_US": {
                    "title": "<vimond-hit-123>Killers</vimond-hit-123> <vimond-hit-123>Of</vimond-hit-123> <vimond-hit-123>The</vimond-hit-123> <vimond-hit-123>Flower</vimond-hit-123> <vimond-hit-123>Moon</vimond-hit-123>"
                }
            },
            "parentId": "415259",
            "liveBroadcastTime": "2024-03-21T05:28:39.000Z",
            "createTime": "2024-03-21T05:28:39.000Z",
            "updateTime": "2024-03-21T05:28:39.000Z",
            "contentCreateTime": null,
            "contentUpdateTime": null,
            "duration": 0,
            "externalSystem": "",
            "externalId": "",
            "isLiveAsset": false,
            "contentType": null,
            "listId": null,
            "isParentAsset": true,
            "assetTypeName": " ",
            "curatedPaths": null
        }
    ]
}