Developers can filter the results in many ways, for example by setting the keyword parameter, you can search any keyword that exists in your video title, description or in the author's name.


To set User Context and get user specific Videos back, either use VIDIZMO JS Login API before calling this method or use VIDIZMO Web Login method and additionally pass "access_token" parameter to this call API.


Request



Parameters


Parameter

Description

keyword
required

The keyword to search for

tag
optional

The tag to search

category_id
optional

Filters result based on the provided category_id

mashup_type
optional

Specifies the type of video, either on-demand or live or both

Possible values: 0 = Live, On - Demand, 1 = Live, 2 = On - Demand

sort
optional

Sorts result based on the numeric value passed.

Possible values: 0 = Title, 1 = Duration, 2 = Top Rated, 3, Most Viewed, 4 = Most Recent, 5 = Most Favorites, 6 = Most Commented, 7 = Most Relevant

order
optional

The sort order of result

Possible values: asc/desc

count
optional

Number of records to fetch in result

page
optional

Page index

is_playlist
optional 

To get video playlist only, set it to ‘true’.

true/ false

Is_featured
optional 

To get featured videos.

true/ false.

mashup_status
optional 

Default value = 2.

Possible values:

1 = draft // To get draft videos.
2 = published // To get published videos
3 = Pending For Approval // To get videos which are under moderation.
4 = Rejected // To get videos which have been rejected to be approved.


Response

 

{
  "result": {
    "related_tags": [],
    "mashups": [
      {
        "custom_mashup_attributes": [
          {
            "custom_attribute_id": 94,
            "custom_attribute_value": "",
            "custom_attribute_name": "Color",
            "id": 1341,
            "mashup_id": 108746,
            "tenant_id": 5145
          }
        ],
        "id": 108746,
        "id_hash": "9Z2GppiEyXp%2ftbd5NKXKHA%3d%3d",
        "weight": 0,
        "title": "Windows-Azure-Pack-Overview (Copy 4)",
        "duration": 0,
        "thumbnail_url": "http://vidizmo.blob.core.windows.net/nadeem-5145/186987/Images/00000f/ImgThumbs/F1B852547047201504140529092721-pptx_small_1.jpg",
        "content_count": 1,
        "thumbnail_large_url": "",
        "thumbnail_medium_url": "",
        "long_description": "",
        "description": "",
        "size": 2596086,
        "tenant": {
          "id": 5145,
          "name": null,
          "domain": "twitter.nadeem.tv",
          "logo_url": null,
          "parent_tenant_id": 0,
          "weight": 0,
          "is_featured": null,
          "welcome_message": null,
          "welcome_title": null,
          "parent_tenant_logo_url": null
        },
        "owner": {
          "user_profile": {
            "id": 0,
            "first_name": "Muhammad",
            "last_name": "",
            "email_address": null
          },
          "tenant": null,
          "tenant_id": 0,
          "user_id": 186987
        },
        "tags": [],
        "created_date": "2015-04-14T05:24:37.053Z",
        "published_date": "2015-04-14T05:33:02.693Z",
        "is_live": false,
        "is_sellable": false,
        "price": 0,
        "total_likes": 0,
        "total_dislikes": 0,
        "total_rating": 0,
        "total_favorites": 0,
        "total_bans": 0,
        "total_views": 0,
        "is_featured": false,
        "channel_name": null,
        "mashup_status": 3,
        "updated_date": "2015-04-14T05:24:37.053",
        "mashup_format": 3,
        "number_of_users": 0,
        "is_enforce_quiz_completion": null,
        "is_expired": false,
        "expiry_date": null,
        "show_on_channel_library": true,
        "total_no_of_sessions": 0,
        "mashup_status_value": "Published",
        "client_time_zone_offset": 0,
        "total_comments": 0,
        "mashup_meta_info_tag": "",
        "mashup_meta_info_category_name": "General",
        "mashup_format_value": "Document",
        "loop": false,
        "enforce_order": false,
        "enforce_completion": false,
        "default_viewing_access": "MainChannelUsers",
        "comment_moderation_required": false,
        "auto_play": false,
        "auto_advance": false,
        "published_on": "2015-04-14T05:22:47.407"
      }
    ],
    "count": 1
  },
  "status": 1,
  "status_code": 200,
  "message": null
}

 



To learn more how these Widgets work, click here on VIDIZMO Web API Library.

For a complete list of VIDIZMO APIs, click here on VIDIZMO Developer APIs.