API Configuration and Limits
Use the limits below to plan request rates, page sizes and report date ranges.
Use these limits when configuring your integration.
The shared request-rate limit applies to all Partnership operations. The tables list additional limits for specific operations; they are not the complete API inventory. An operation missing from a table does not mean unlimited access. See API Reference for supported parameters and other restrictions.
Request rates
| Operation | Requests | Window (seconds) |
|---|---|---|
| All Partnership operations combined | 600 | 60 |
POST /v1/partnership/affiliation | 100 | 60 |
POST /v1/partnership/referral-agent-links | 5 | 60 |
POST /v1/partnership/referral-agent-links/{agent_link_id}/archive | 60 | 60 |
The overall budget is 600 requests per 60 seconds per partner, shared across all of that partner's API keys. Creating or switching keys does not provide a separate overall budget. Coordinate request scheduling across the applications and workers using those keys.
Operation-specific limits apply in addition to the shared budget. A request must fit both limits where an operation-specific rate is listed.
Startup flow
- 1Prepare credentials and confirm access with Send Your First Request.
- 2Configure request scheduling, page sizes and date ranges using the tables on this page.
- 3Match each request to its operation and apply the shared rate limit, any additional operation limit, and the relevant page-size or date-range settings.
- 4Coordinate request counts across workers and keys for the same partner. Apply backoff when a rate-limit error is returned.
REST capacity planning
Track the total requests sent for the partner and the requests sent for operations with an additional rate limit. Delay a request when either applicable budget is exhausted. Spread requests over time instead of treating the listed values as permission to send a burst.
Local counters help schedule requests; they do not guarantee server-side capacity, especially if other applications use the same partner's keys. Always handle rate-limit responses.
Request limits
Page sizes
For the operations below, limit controls the number of rows requested. If you omit it, the default applies.
These values apply only to the listed operations. Keep filters and ordering unchanged while paging. See Reports for report selection and reconciliation.
Date ranges
| Operation | Condition | Maximum days |
|---|---|---|
GET /v1/partnership/reports/clients/registrations/byday | Maximum date range | 366 |
GET /v1/partnership/reports/conversion | Maximum date range when grouping by day | 180 |
GET /v1/partnership/reports/orders | Maximum date range | 32 |
For larger exports, request smaller date ranges within the applicable limit. Follow the selected operation's date-filter definitions in API Reference.
Rate-limit errors
On HTTP 429, inspect the returned code and follow Troubleshooting Your API Requests. The Partnership contract documents Throttled and numeric 1003 / AUTH_RATE_LIMIT; use the response for the selected operation.
Slow down
Slow down requests and honor
Retry-Afterwhen returned.Account for other workers
Account for requests from other workers and API keys belonging to the same partner.
Retry deliberately
Retry only when the operation is still needed and the applicable recovery guidance permits it. Generate a fresh timestamp and signature for each retry.