Retrieve a Stream

Retrieves the details of an existing stream.

GET /v1/streams/{STREAM_ID}

Retrieve a Stream

cURL

curl --request GET \
  --url https://api.domo.com/v1/streams/{STREAM_ID} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 42,
  "dataSet": {
    "id": "0c1e0dbe-9f71-4625-9b50-b79e6e4266f2",
    "name": "Leonhard Euler Party",
    "description": "Mathematician Guest List",
    "rows": 0,
    "columns": 0,
    "owner": {
      "id": 27,
      "name": "DomoSupport"
    },
    "createdAt": "2016-05-27T17:53:04Z",
    "updatedAt": "2016-05-26T21:03:35Z",
    "pdpEnabled": false
  },
  "updateMethod": "APPEND",
  "createdAt": "2016-05-26T21:03:35Z",
  "modifiedAt": "2016-05-26T21:03:35Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

STREAM_ID · number · required

The ID of the Stream

Query Parameters

fields · string

Return desired fields: {all} or {id, dataset, updateMethod, createdAt, or modifiedAt}

Response

200 - application/json

Returns a Stream object if valid Stream ID was provided. When requesting, if the Stream ID is related to a DataSet that has been deleted, a subset of the Stream's information will be returned, including a deleted property, which will be true.

id · integer

dataSet · object

Show child attributes

updateMethod · string

createdAt · string

modifiedAt · string