get
https://{app-url}{}/api/v2/bc/data-streams/totals
Retrieve entities associated with a specific data stream
Use this API to retrieve the entities associated with a data stream. Supported entity types include alerts, dashboards, and composites.
An entity is considered connected to a stream if it references that stream in its configuration. For example, an alert is connected to a stream if it was created using metrics from that stream, and the stream object is explicitly stated in its metric expression. The same applies to dashboards and composites.
This information is equivalent to the Alerts & Dashboards tab displayed in the stream summary.
Request Arguments
| Argument | Type | Description |
|---|---|---|
| streamId | string | Data stream ID to retrieve. |
Response Fields
| Field | Type | Description / Example |
|---|---|---|
| alerts | array | Array of connected alerts. Each alert includes its id and title. The response also includes the total number of connected alerts. |
| composites | array | Array of connected composites. Each composite includes its id and title. The response also includes the total number of connected composites. |
| dashboards | array | Array of connected dashboards. Each dashboard includes its id and title. The response also includes the total number of connected dashboards. |