Skip to main content
GET
/
v1
/
analytics
/
buckets
/
{bucket_id}
/
sync-performance
Get Sync Performance
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/sync-performance
{
  "bucket_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "runs": [
    {
      "sync_run_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "duration_seconds": 123,
      "files_discovered": 123,
      "files_synced": 123,
      "files_failed": 123,
      "bytes_synced": 123,
      "throughput_mbps": 123,
      "status": "<string>",
      "provider_type": "<string>"
    }
  ],
  "sync_config_id": "<string>",
  "summary": {}
}

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

​
X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Path Parameters

​
bucket_id
string
required

Query Parameters

​
sync_config_id
string | null

Filter by sync config ID

​
hours
integer
default:168

Hours of history (default: 7 days)

Required range: 1 <= x <= 720
​
limit
integer
default:100

Maximum sync runs to return

Required range: 1 <= x <= 1000

Response

Successful Response

Sync performance analytics response.

​
bucket_id
string
required

Bucket identifier

​
time_range
TimeRange · object
required

Query time range

​
runs
SyncRunMetric · object[]
required

Sync run metrics

​
sync_config_id
string | null

Optional sync config filter

​
summary
Summary · object

Summary statistics