API

List Lives

GET /v1/lives

List Lives

Query parameters

  • page integer | null

    The page number in a paginated set of results

  • limit integer | null

    The limit of results to be returned per page

  • title[eq] string

    Search Lives with a specific title

  • title[contains] string

    Search Lives that contains this in the title

  • status[eq] string

    Search Lives with a specific status

    Values are Ended, Planned, or Live.

  • startDate[lt] integer

    Return elements with date before than this

  • startDate[lte] integer

    Return elements with date before than or equal to this

  • startDate[gt] integer

    Return elements with date after than this

  • startDate[gte] integer

    Return elements with date after than or equal to this

  • startDate[eq] integer

    Return elements with date equal to this

  • solution[in] array[string]

    Search Lives with theses types of solution

    Values are Youtube, Vimeo, BuiltIn, or NoSolution.

  • solution[eq] string

    Search Lives with a specific solution

    Values are Youtube, Vimeo, BuiltIn, or NoSolution.

  • replay[eq] string

    Search Lives with or without replay

  • builtInType[in] array[string]

    Search Lives with theses types of BuiltInType

    Values are Workshop or Conference.

  • builtInType[eq] string

    Search Lives with a specific BuiltInType

    Values are Workshop or Conference.

  • averageViewTime[lt] integer

    Return elements with value lower than this

  • averageViewTime[lte] integer

    Return elements with value lower than or equal to this

  • averageViewTime[gt] integer

    Return elements with value greater than this

  • averageViewTime[gte] integer

    Return elements with value greater than or equal to this

  • averageViewTime[eq] integer

    Return elements with value equal to this

  • invited[lt] integer

    Return elements with value lower than this

  • invited[lte] integer

    Return elements with value lower than or equal to this

  • invited[gt] integer

    Return elements with value greater than this

  • invited[gte] integer

    Return elements with value greater than or equal to this

  • invited[eq] integer

    Return elements with value equal to this

  • registrant[lt] integer

    Return elements with value lower than this

  • registrant[lte] integer

    Return elements with value lower than or equal to this

  • registrant[gt] integer

    Return elements with value greater than this

  • registrant[gte] integer

    Return elements with value greater than or equal to this

  • registrant[eq] integer

    Return elements with value equal to this

  • attendee[lt] integer

    Return elements with value lower than this

  • attendee[lte] integer

    Return elements with value lower than or equal to this

  • attendee[gt] integer

    Return elements with value greater than this

  • attendee[gte] integer

    Return elements with value greater than or equal to this

  • attendee[eq] integer

    Return elements with value equal to this

  • attendanceRate[lt] integer

    Return elements with value lower than this

  • attendanceRate[lte] integer

    Return elements with value lower than or equal to this

  • attendanceRate[gt] integer

    Return elements with value greater than this

  • attendanceRate[gte] integer

    Return elements with value greater than or equal to this

  • attendanceRate[eq] integer

    Return elements with value equal to this

  • totalReplayView[lt] integer

    Return elements with value lower than this

  • totalReplayView[lte] integer

    Return elements with value lower than or equal to this

  • totalReplayView[gt] integer

    Return elements with value greater than this

  • totalReplayView[gte] integer

    Return elements with value greater than or equal to this

  • totalReplayView[eq] integer

    Return elements with value equal to this

Responses

  • 200 application/json

    Lives returned successfully

    Hide response attributes Show response attributes object
    • items array[object] Required

      The items found

      Hide items attributes Show items attributes object
      • id string Required

        The id of the Live.

      • title string Required

        The title of the Live.

      • startDate string(date-time) Required

        The startDate of the Live.

      • endDate string(date-time) Required

        The endDate of the Live.

      • metrics object Required

        The metrics of the Live.

        Hide metrics attributes Show metrics attributes object
        • averageViewTime integer | null Required

          The average view time on the Live.

        • noShow integer | null Required

          The counter of no show of the Live.

        • totalReplayView integer | null Required

          The counter of total replay viewed on the Live.

        • registrant integer | null Required

          The counter of registrant on the Live.

        • attendee integer | null Required

          The counter of attendee on the Live.

        • attendanceRate integer | null Required

          The attendance rate on the Live.

        • invited integer | null Required

          The counter of invited on the Live.

      • description array[object] Required

        The description of the Live.

      • status string Required

        The status of the Live.

        Values are Ended, Planned, or Live.

      • computedStatus string Required

        The computed status of the Live.

        Values are Ended, Planned, or Live.

      • solution string Required

        The solution of the Live.

        Values are Youtube, Vimeo, BuiltIn, or NoSolution.

      • privacy object Required

        The privacy of the Live.

        Hide privacy attributes Show privacy attributes object
        • visibility string Required

          The visibility of the Live

          Values are AnyOne, OnlySpotMembers, or InvitedMembersOnly.

        • participation string Required

          What kind of members can participate to the Live

          Values are AnySpotMembers or InvitedMembersOnly.

      • config object Required

        The configuration of the Live.

        Hide config attributes Show config attributes object
        • chatVisibility string Required

          The chat visibility on the Live

          Values are Display or Hidden.

        • participantsVisibility string Required

          The participants visibility on the Live.

          Values are Ended, Planned, or Live.

      • builtInType string | null Required

        The builtIn type of the Live.

        Values are Workshop or Conference.

      • videoUrl object | null Required

        The video URL of the Live.

      • createdAt string(date-time) Required

        The creation date of the Live.

      • spotId string Required

        The spot ID of the Live.

      • builtInConfig object | null Required

        The builtIn configuration of the Live.

        Hide builtInConfig attributes Show builtInConfig attributes object | null
        • isRecorded boolean Required

          Indicates if the Live is recorded

        • recordAvailable boolean Required

          If Live is recorded, indicates if the record is available

        • enableBreakoutRooms boolean Required

          Indicates if the Live has breakout rooms enabled

        • enableRaiseHand boolean Required

          Indicates if the Live has raise hand enabled

        • enablePictureInPicture boolean Required

          Indicates if the Live has picture-in-picture enabled

        • videos object Required

          Videos of the replay in multiple formats

          Hide videos attributes Show videos attributes object
          • url string Required

            URL to the video

          • quality string Required

            Quality of the video

          • encoding string Required

            Encoding of the video

            Values are hls or mp4.

          • createdAt string(date-time) | null Required

            Creation date of the video

        • replayVideo object | null Required

          URL to video replay

    • total integer Required

      The total number of items found
  • 400

    Malformed payload

GET /v1/lives 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/lives'
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "title": "string",
      "startDate": "2025-05-04T09:42:00Z",
      "endDate": "2025-05-04T09:42:00Z",
      "metrics": {
        "averageViewTime": 42,
        "noShow": 42,
        "totalReplayView": 42,
        "registrant": 42,
        "attendee": 42,
        "attendanceRate": 42,
        "invited": 42
      },
      "description": [
        {
          "type": "p",
          "children": [
            {
              "text": "My new live"
            }
          ]
        }
      ],
      "status": "Ended",
      "computedStatus": "Ended",
      "solution": "Youtube",
      "privacy": {
        "visibility": "AnyOne",
        "participation": "AnySpotMembers"
      },
      "config": {
        "chatVisibility": "Display",
        "participantsVisibility": "Ended"
      },
      "builtInType": "Workshop",
      "videoUrl": {},
      "createdAt": "2025-05-04T09:42:00Z",
      "spotId": "string",
      "builtInConfig": {
        "isRecorded": true,
        "recordAvailable": true,
        "enableBreakoutRooms": true,
        "enableRaiseHand": true,
        "enablePictureInPicture": true,
        "videos": {
          "url": "string",
          "quality": "string",
          "encoding": "hls",
          "createdAt": "2025-05-04T09:42:00Z"
        },
        "replayVideo": {}
      }
    }
  ],
  "total": 42
}