LYlytics
Stream

Update a Stream

Update a stream with a given ID. The parameters listed below provided in the PUT request will overwrite the current parameters in the model.

Stream attributes that a user is able to update:

  • slug (string) ... raw value of the stream as it appears in both queries and collection

  • channel (string, optional) ... method by which this stream collects data. Only allowable channel types: web, email, mobile, ad, sms, pos

  • label (string, optional) ... user assignable label, for display in the UI

  • description (string, optional) ... user assignable description

  • providers ([]string, optional) ... names of the providers that send data on this stream

put/api/stream/{id}

Request

  • Base URL
    https://api.lytics.io
  • URL
    https://api.lytics.io/api/stream/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

ID of the stream in the form of a hash. You can also use the slug.

Query parameters

account_idstring

Your Lytics account ID.

Response

JSON representation of Streams Resource.

messagestring
statusnumber

Example response

{
  "data": [
    {
      "account_id": "d8e403de6fbf0090b17b42a2bb37716e",
      "aid": 2,
      "channel": "email",
      "created": "2018-07-31T22:41:21.908Z",
      "hidden": false,
      "id": "765ed319ddc918e6bb5f9b1d6359a3c4",
      "method": "",
      "providers": [],
      "slug": "hellow",
      "tables": [],
      "updated": "2018-07-31T22:41:21.908Z"
    }
  ],
  "message": "success",
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.