feat: get subscribers endpoint #1391
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| - `POST /v1/<project-id>/get-subscribers` | ||
| - Each app can call this endpoint 100 times per second with a burst up to 100. Rate limited requests will return a 429 status code. | ||
| - `GET /<project-id>/subscribers` | ||
| - Each app can call this endpoint 1 time every 5 minutes with a burst up to 2. Rate limited requests will return a 429 status code. |
There was a problem hiding this comment.
Note: rate limit for old endpoint been reduced. I am working with developers to switch to new endpoint before enforcing the new rate limit.
There was a problem hiding this comment.
Can we be explicit about what qualifies as a burst here? I'm a bit confused (and suspect external devs may be) how a burst is counted.
Assuming 1 per 5 minutes but we'll allow 2 if within some short interval?
There was a problem hiding this comment.
This question is asked a lot. I linked to the token bucket Wikipedia article above and tried to summarize it, but not doing a good job
| - `GET /subscribers` | ||
| - Each app can call this endpoint 1 time per second with a burst up to 5. Rate limited requests will return a 429 status code. | ||
| - `POST /v1/<project-id>/get-subscribers` | ||
| - Each app can call this endpoint 100 times per second with a burst up to 100. Rate limited requests will return a 429 status code. |
There was a problem hiding this comment.
I'm taking a stab at some numbers for the limits, 100 accounts, 100/s, and 100 burst seem somewhat sensible
| - `POST /v1/<project-id>/get-subscribers` | ||
| - Each app can call this endpoint 100 times per second with a burst up to 100. Rate limited requests will return a 429 status code. | ||
| - `GET /<project-id>/subscribers` | ||
| - Each app can call this endpoint 1 time every 5 minutes with a burst up to 2. Rate limited requests will return a 429 status code. |
There was a problem hiding this comment.
Can we be explicit about what qualifies as a burst here? I'm a bit confused (and suspect external devs may be) how a burst is counted.
Assuming 1 per 5 minutes but we'll allow 2 if within some short interval?
Nobody has really asked for the notification types yet, but I've had thoughts about this as well as the "created at" timestamp which could've been somewhat helpful with our NFT campaign. Might as well add that too. |
| @@ -132,8 +215,10 @@ To protect our system and subscribers, various limits and rate limits are in-pla | |||
|
|
|||
| Rate limits are implemented as [token bucket](https://en.wikipedia.org/wiki/Token_bucket) and contain both rate and burst amounts. On average, a rate of requests can be made. However, since real-world applications often make requests in bursts, this fixed rate can be surpassed temporarily up to the burst amount, provided the app subsequently makes requests below the average in order to recover its bursting capability. | |||
|
|
|||
| - `POST /notify`: | |||
| - `POST /<project-id>/notify`: | |||
There was a problem hiding this comment.
Fixing this; was inaccurate
Existing
/subscribersendpoint downloads all subscribers, which is expensive and takes time. However, usually developers don't need all subscribers, and may just want to know if a specific subscriber is subscribed or not.This feature is not implemented yet and currently gathering feedback on these docs. Once implemented, this PR will be merged.