Skip to main content
POST
/
v1
/
streams
Create a Stream
curl --request POST \
  --url https://api.domo.com/v1/streams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataSet": {
    "name": "Leonhard Euler Party",
    "description": "Mathematician Guest List",
    "schema": {
      "columns": [
        {
          "type": "STRING",
          "name": "Friend"
        },
        {
          "type": "STRING",
          "name": "Attending"
        }
      ]
    }
  },
  "updateMethod": "APPEND"
}
'
{
  "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-27T17:53:10Z",
    "pdpEnabled": false
  },
  "updateMethod": "APPEND",
  "createdAt": "2016-05-27T17:53:05Z",
  "modifiedAt": "2016-05-27T17:53:05Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
dataSet
object
required

The Dataset object to be created with the Stream

​
updateMethod
string

The data import behavior: "APPEND" or "REPLACE"

​
keyColumnNames
string[]

keyColumnNames defines the upsert key for upsert Datasets.

Response

200 - application/json

Returns a DataSet object when successful. The returned object will have DataSet attributes based on the information that was provided when DataSet was created from the Stream created.

​
id
integer
​
dataSet
object
​
updateMethod
string
​
createdAt
string
​
modifiedAt
string