{
  "id": "sync_source_stats",
  "title": "Database syncer source stats requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/bdbs/sync_source_stats/",
  "summary": "Syncer source statistics requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-all-bdbs-sync_source_stats) | `/v1/bdbs/{bdb_uid}/sync_source_stats` | Get stats for all syncer sources |\n| [GET](#get-bdbs-sync_source_stats) | `/v1/bdbs/{bdb_uid}/sync_source_stats/{uid}` | Get stats for a specific syncer instance |\n\n## Get all syncer source stats {#get-all-bdbs-sync_source_stats}\n\n```sh\nGET /v1/bdbs/{bdb_uid}/sync_source_stats\n```\n\nGet stats for all syncer sources of a local database.\n\n### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [view_bdb_stats]() | admin\u003cbr /\u003ecluster_member\u003cbr /\u003ecluster_viewer\u003cbr /\u003edb_member\u003cbr /\u003edb_viewer\u003cbr /\u003euser_manager |\n\n### Request {#get-all-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/bdbs/1/sync_source_stats?interval=5min\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| bdb_uid | integer | The unique ID of the local database. |\n\n#### Query parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| interval | string | Time interval for which we want stats: 1sec/10sec/5min/15min/1hour/12hour/1week (optional) |\n| stime | ISO_8601 | Start time from which we want the stats. Should comply with the [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) format (optional) |\n| etime | ISO_8601 | Optional end time after which we don't want the stats. Should comply with the [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) format (optional) |\n\n### Response {#get-all-response}\n\nReturns [statistics]() for all syncer sources.\n\n#### Example JSON body\n\n```json\n{ \"sync_source_stats\": [\n     {\n         \"intervals\": [\n             {\n                 \"etime\": \"2017-10-22T19:30:00Z\",\n                 \"ingress_bytes\": 18528,\n                 \"ingress_bytes_decompressed\": 185992,\n                 \"interval\": \"5min\",\n                 \"local_ingress_lag_time\": 0.244,\n                 \"stime\": \"2017-10-22T19:25:00Z\"\n             },\n             {\n                 \"etime\": \"2017-10-22T19:35:00Z\",\n                 \"ingress_bytes\": 18,\n                 \"ingress_bytes_decompressed\": 192,\n                 \"interval\": \"5min\",\n                 \"local_ingress_lag_time\": 0.0,\n                 \"stime\": \"2017-10-22T19:30:00Z\"\n             }\n         ],\n         \"uid\": \"1\"\n     }\n   ]\n }\n```\n\n### Status codes {#get-all-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | No error |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Database does not exist. |\n\n## Get syncer instance stats {#get-bdbs-sync_source_stats}\n\n```sh\nGET /v1/bdbs/{bdb_uid}/sync_source_stats/{int: uid}\n```\n\nGet stats for a specific syncer (Replica Of) instance.\n\n#### Permissions\n\n| Permission name | Roles |\n|-----------------|-------|\n| [view_bdb_stats]() | admin\u003cbr /\u003ecluster_member\u003cbr /\u003ecluster_viewer\u003cbr /\u003edb_member\u003cbr /\u003edb_viewer\u003cbr /\u003euser_manager |\n\n### Request {#get-request}\n\n#### Example HTTP request\n\n```sh\nGET /v1/bdbs/1/sync_source_stats/1?interval=5min\n```\n\n#### Headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n#### URL parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| bdb_uid | integer | The unique ID of the local database. |\n| uid | integer | The sync_source uid. |\n\n#### Query parameters\n\n| Field | Type | Description |\n|-------|------|-------------|\n| interval | string | Time interval for which we want stats: 1sec/10sec/5min/15min/1hour/12hour/1week (optional) |\n| stime | ISO_8601 | Optional start time from which we want the stats. Should comply with the [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) format (optional) |\n| etime | ISO_8601 | Optional end time after which we don't want the stats. Should comply with the [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) format (optional) |\n\n### Response {#get-response}\n\nReturns [statistics]() for a specific syncer instance.\n\n#### Example JSON body\n\n```json\n{\n    \"intervals\": [\n        {\n            \"etime\": \"2017-10-22T19:30:00Z\",\n            \"ingress_bytes\": 18528,\n            \"ingress_bytes_decompressed\": 185992,\n            \"interval\": \"5min\",\n            \"local_ingress_lag_time\": 0.244,\n            \"stime\": \"2017-10-22T19:25:00Z\"\n        },\n        {\n            \"etime\": \"2017-10-22T19:35:00Z\",\n            \"ingress_bytes\": 18,\n            \"ingress_bytes_decompressed\": 192,\n            \"interval\": \"5min\",\n            \"local_ingress_lag_time\": 0.0,\n            \"stime\": \"2017-10-22T19:30:00Z\"\n        }\n    ],\n    \"uid\": \"1\"\n}\n```\n\n### Status codes {#get-status-codes}\n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | No error |\n| [404 Not Found](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5) | Database or sync_source do not exist. |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}