API 参考订阅 API

订阅详情

单个订阅的命中数与最近 20 次投递。

GET/api/v1/subscriptions/{id}
GET
/api/v1/subscriptions/{id}

单个订阅 + 当前命中多少仓库 + 最近 20 条投递记录(eventId / status / attempt / httpStatus / error)。

没有这段的话,订阅方唯一的排障手段就是「等明天看数据有没有更新」(§6.8)。

matchedRepos 为 0 时,水位线既不推进也不回退:把水位线退到一个空集合的起点,等于让下一次投递重推全表(§6.4)。

Authorization

bearerAuth
AuthorizationBearer <token>

Authorization: Bearer <key>。key 由控制台自助签发,或管理员在 /dashboard 代签

In: header

Path Parameters

id*string

订阅 id(subscriptions.id)

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/subscriptions/string"
{  "id": "string",  "name": "string",  "callbackUrl": "string",  "signingKeyPrefix": "string",  "cadence": "daily",  "mode": "batch",  "scopes": [    "repos.stats"  ],  "filters": {    "repoIds": [      "string"    ],    "projectTypes": [      "client"    ],    "categoryCodes": [      "string"    ],    "includePlatformProjects": true,    "includeUncurated": true,    "includeOwnSubmissions": true  },  "filtersVersion": 0,  "enabled": true,  "disabledReason": "too_many_failures",  "watermark": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "signingKey": "string",  "matchedRepos": 0,  "lastDeliveredAt": "2019-08-24T14:15:22Z",  "lastError": "string",  "consecutiveFailures": 0,  "deliveries": [    {      "eventId": "string",      "status": "pending",      "attempt": 0,      "httpStatus": 0,      "error": "string",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}