Stream

Create a Stream

JSON Parameters:

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

  • channel (string) ... 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

  • tables ([]string, optional) ... names of the tables to which this stream writes

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

  • hidden (bool, optional) ... whether stream is hidden in stream stats?

  • method (string, optional) ... either 'bulk' or 'streaming'

post/api/stream

Request

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

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.