You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/data-assets/apis/api-endpoint.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1363,6 +1363,34 @@ for details on defining and using custom properties.
1363
1363
1364
1364
---
1365
1365
1366
+
## Followers
1367
+
1368
+
**Stay informed about API endpoint changes**
1369
+
1370
+
Followers allow users to "follow" API endpoints and receive notifications when they change. This is critical for:
1371
+
1372
+
-**API Consumers**: Monitor endpoints your applications depend on
1373
+
-**Backend Engineers**: Track endpoints you own or maintain
1374
+
-**Integration Teams**: Stay informed about contract changes
1375
+
-**API Product Managers**: Monitor endpoint usage and evolution
1376
+
1377
+
**Key Benefits**:
1378
+
- Receive notifications about breaking changes to request/response schemas
1379
+
- Track deprecation notices and versioning changes
1380
+
- Monitor authentication or rate limiting updates
1381
+
- Get alerts for SLA or performance threshold changes
1382
+
1383
+
**Common Use Cases**:
1384
+
- Frontend developers follow endpoints their apps consume
1385
+
- Backend engineers follow production endpoints they maintain
1386
+
- DevOps teams follow critical API endpoints for monitoring
1387
+
- Product teams follow public API endpoints for customer impact
1388
+
1389
+
!!! tip "Learn More"
1390
+
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1040
+
1041
+
---
1042
+
1015
1043
## API Operations
1016
1044
1017
1045
All Chart operations are available under the `/v1/charts` endpoint.
- Analysts follow dashboards they've created or contributed to
1058
+
- Data engineers follow dashboards to monitor data pipeline health
1059
+
1060
+
!!! tip "Learn More"
1061
+
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1062
+
1063
+
---
1064
+
1037
1065
## API Operations
1038
1066
1039
1067
All Dashboard operations are available under the `/v1/dashboards` endpoint.
Copy file name to clipboardExpand all lines: docs/data-assets/messaging/topic.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1233,6 +1233,34 @@ for details on defining and using custom properties.
1233
1233
1234
1234
---
1235
1235
1236
+
## Followers
1237
+
1238
+
**Stay informed about topic changes**
1239
+
1240
+
Followers allow users to "follow" a topic and receive notifications when it changes. This is critical for:
1241
+
1242
+
-**Event Producers**: Monitor topics they publish to
1243
+
-**Event Consumers**: Track schema changes in topics they consume
1244
+
-**Platform Teams**: Get notified of topic configuration changes
1245
+
-**Compliance**: Monitor topics with sensitive data
1246
+
1247
+
**Key Benefits**:
1248
+
- Receive notifications about schema changes (critical for compatibility)
1249
+
- Track partition count or replication factor changes
1250
+
- Monitor retention policy or configuration updates
1251
+
- Get alerts for deprecation, ownership, or governance changes
1252
+
1253
+
**Common Use Cases**:
1254
+
- Developers follow topics their services consume
1255
+
- Platform engineers follow all production topics
1256
+
- Data scientists follow topics with ML training events
1257
+
- Compliance officers follow topics with PII or sensitive data
1258
+
1259
+
!!! tip "Learn More"
1260
+
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1261
+
1262
+
---
1263
+
1236
1264
## API Operations
1237
1265
1238
1266
All Topic operations are available under the `/v1/topics` endpoint.
Copy file name to clipboardExpand all lines: docs/data-assets/ml/mlmodel.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1419,6 +1419,34 @@ for details on defining and using custom properties.
1419
1419
1420
1420
---
1421
1421
1422
+
## Followers
1423
+
1424
+
**Stay informed about ML model changes**
1425
+
1426
+
Followers allow users to "follow" an ML model and receive notifications when it changes. This is valuable for:
1427
+
1428
+
-**Data Scientists**: Monitor models they've developed or deployed
1429
+
-**ML Engineers**: Track model version changes and deployments
1430
+
-**Stakeholders**: Stay informed about production model updates
1431
+
-**Compliance**: Monitor models for governance and regulatory requirements
1432
+
1433
+
**Key Benefits**:
1434
+
- Receive notifications about model version updates
1435
+
- Track feature or algorithm changes
1436
+
- Monitor performance metrics and drift
1437
+
- Get alerts for ownership, deprecation, or governance updates
1438
+
1439
+
**Common Use Cases**:
1440
+
- Data scientists follow models in production
1441
+
- ML engineers follow models they deploy and maintain
1442
+
- Product managers follow models powering product features
1443
+
- Compliance teams follow models with regulatory implications
1444
+
1445
+
!!! tip "Learn More"
1446
+
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1447
+
1448
+
---
1449
+
1422
1450
## API Operations
1423
1451
1424
1452
All ML Model operations are available under the `/v1/mlmodels` endpoint.
-**Operations**: Get notified of pipeline failures or configuration changes
1219
+
-**Stakeholders**: Stay informed about ETL processes affecting their data
1220
+
1221
+
**Key Benefits**:
1222
+
- Receive notifications about pipeline configuration changes
1223
+
- Track task additions, removals, or modifications
1224
+
- Monitor pipeline schedule or trigger changes
1225
+
- Get alerts for ownership, deprecation, or governance updates
1226
+
1227
+
**Common Use Cases**:
1228
+
- Data engineers follow production pipelines they maintain
1229
+
- Analysts follow pipelines that refresh their reports
1230
+
- Data scientists follow pipelines feeding their ML models
1231
+
- Operations teams follow critical data pipelines
1232
+
1233
+
!!! tip "Learn More"
1234
+
See the complete **[Followers Guide](../../core-concepts/followers.md)** for detailed information about configuring notifications, best practices, and integration with webhooks.
1235
+
1236
+
---
1237
+
1210
1238
## API Operations
1211
1239
1212
1240
All Pipeline operations are available under the `/v1/pipelines` endpoint.
0 commit comments