Sign in
Streams

Get Streams Data

Changed on

Get streams, optionally filtered by stream ID or organization ID. Use estimatedLiveApr for the rate a stream is currently distributing; lastSnapshot.apr is historical and stays populated after a stream is paused or ends.

get/v2/streams/

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

idstring uuid nullable
Example:248df4b7-aa70-47b8-a036-33ac447e668d
orgIdstring uuid nullable
Example:248df4b7-aa70-47b8-a036-33ac447e668d
withSnapshotsboolean
usersCountboolean

Response

OK

Example response

{
  "streams": [
    {
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "orgId": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "point": {
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "orgId": "248df4b7-aa70-47b8-a036-33ac447e668d"
      },
      "rewardToken": {
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d"
      },
      "userId": "248df4b7-aa70-47b8-a036-33ac447e668d"
    }
  ]
}

Changes

  • v260527ba59276Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • v2a0341c6f8cbcRevision changes
    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status