Get stream definition

GET

api/v3/stream/s/:stream_id

Get stream definition

Path Parameters

• stream_id string required
  Example: stream_1

Responses

• 200
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "request": "GET /api/v3/stream/s/stream_1?access_token=abcd_1234_abcd",
  "request_id": "#r8ug02quyhun#",
  "result_stream": {
    "data": [
      {
        "enabled": true,
        "rules": [
          {
            "query": "cats AND dogs",
            "rule_id": "rule_1"
          }
        ],
        "stream_id": "stream_1"
      }
    ]
  },
  "status_code": "0",
  "status_message": "OK"
}

Not Found

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "request": "GET /api/v3/stream/s/stream_2?access_token=abcd_1234_abcd",
  "request_id": "#r8ufyunv6z3g#",
  "result_error": {
    "data": [
      {
        "key": "stream_id",
        "value": [
          "stream_2"
        ]
      }
    ]
  },
  "status_code": "15",
  "status_message": "Wrong stream id. No such stream defined."
}

Loading...