Haus Live
  • ✨Overview
    • Haus Live Digital Partner Platform
    • Why Consider the Platform?
    • Getting Started
  • 🛠️For Developers
    • API Overview
    • Streaming Specifications
    • Authentication
    • Whitelisting
    • API Reference
      • /media/list
      • /stream/{media_id}
      • Field Data Reference
        • Categories
        • Durations
        • Difficulties
Powered by GitBook
On this page
  • GET /media/list
  • Purpose
  • Response Object
  • Response Field Information
  1. For Developers
  2. API Reference

/media/list

GET /media/list

Purpose

Retrieves the full video listings.

Response Object

[
  {
    mediaId : "ABCDEFG1234567890",
    creationTime: 1625601180694,
    catagories: [ "cardio" ],
    title: "Cardio: 20min Low Impact",
    description: "All that HIIT training without the impact. This cardio workout involves simple yet effective moves that invigorate you.",
    difficulties: [ "beginner", "intermediate"],
    durationCategory: "20m",
    equipments: false,
    instructors: [ "Tris Kong" ],
    mainDifficulty: "beginner",
    thumbnailUrl : "https://assets.haus.live/media/ABCDEFG1234567890/thumb.gif"
  }
  
  ...
]

Response Field Information

Field
Notes

mediaId

The unique ID of the workout. This is required as a parameter to retrieve the stream URL in the /stream/{media_id} API call

creationTime

The time the workout was added to the platform. Format: Value is in epoch milliseconds

categories

title

A short description good for displaying in search results

description

A longer description aimed to provide more information after a user has selected a workout to find out more information

difficulties

durationCategory

equipments

Indicates if a workout uses equipment e.g. dumbbells. Type: Boolean - true : equipment required - false : equipment not required

instructors

A list of instructor names in the workout.

mainDifficulty

Some workouts can cater for multiple levels. This difficulty represents the main difficulty group it was designed for.

thumbnailURL

A thumbnail image to be used as a preview. This will be a full URL with host information.

PreviousAPI ReferenceNext/stream/{media_id}

Last updated 2 years ago

The categories the workout is assigned. A workout can have more that one category. See for the full list of data vales

The difficulty level the workout is assigned. A workout can have more that one difficulty. See for the full list of data vales

The duration category the workout is assigned. Only one can be assigned. See for the full list of data vales

🛠️
Categories
Difficulties
Durations