Open navigation

Video details API

This API helps you get the details of all the videos that are available in your user’s Hippo Video account.

The following are the details that you can provide to your users - video title, folder or the category in which the video is available, video description, and video tags.

Also, while displaying the videos to your customers you can attach the params (hemail, hfname, and hlname) to track the viewer profile.


URL

GET -> api/v1/me/video/video_id

Params

email - email of the user

api_key - Api Key of the user

video_id - id of the video


Response

{

    "code": 200,

    "id": 988,

    "title": "Testing Video",

    "description": "Description of the video",

    "created_at": "2018-12-24T06:02:17.437Z",

    "display_date": "Dec 24, 2018",

    "thumbnail": "https://hippolms-dev-storage.s3-accelerate.amazonaws.com/wiz/videos/thumbnails/v2/Anp52qEvvJb1qEEXuJtHfQ.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJEGJ4ELDMREUIE3A%2F20190110%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20190110T025543Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0f6642d8973208d19ded424a1241a5a1c92db699ae2d357897d64c69e5c266c9",

    "share_url": "http://localhost:3000/video/play/Anp52qEvvJb1qEEXuJtHfQ",

    "token": "Anp52qEvvJb1qEEXuJtHfQ",

    "share_thumbnail": "https://hippolms-dev-storage.s3-accelerate.amazonaws.com/wiz/videos/previews/Anp52qEvvJb1qEEXuJtHfQ.gif",

    "embed_url": "http://localhost:3000/video/embed/Anp52qEvvJb1qEEXuJtHfQ",

    "email_embed": "<div><a href=\"http://localhost:3000/video/play/Anp52qEvvJb1qEEXuJtHfQ\" target=\"_blank\" rel=\"no_opener\"><img style=\"width: 100%; max-width: 360px;\" src=\"https://hippolms-dev-storage.s3-accelerate.amazonaws.com/wiz/videos/previews/Anp52qEvvJb1qEEXuJtHfQ.gif\" alt=\"Video Thumbnail\"/></a></div>",

    "categories": [

        {

            "id": 10,

            "name": "Others"

        },

        {

            "id": 116,

            "name": "1to1Videos"

        }

    ],

    "tags": [

        "marketing",

        "campaigns"

    ]

}


id - Video ID.

title - Title of the video.

description - Description of the video.

created_at - Video creation date.

display_date - Video creation date in word format. (e.g: about a week ago)


The above responses are success cases. In case, any errors occur you’ll see an error response.


To check out other articles related to this topic.


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.