Errors
What each error means and what to do.
Errors are JSON with a code and a message.
| Code | Status | What to do |
|---|---|---|
invalid_input | 400 | A field is missing or the wrong type. The message names it. |
unauthorized | 401 | The API key is missing or was revoked. Create a new one. |
not_found | 404 | There is no tool with that name. |
needs_plan | 402 | Choose a plan in the app to use this. |
over_limit | 402 | This period's allowance is used up. Upgrade in the app, or wait for the next period. |
too_large | 413 | The request body is over the size limit. Send less. |
refused | 422 | The tool turned this request down. The message says why. You were not charged. |
rate_limited | 429 | Too many requests this hour. Wait and try again. |
failed | 502 | The tool could not finish. You were not charged. Try again. |
unavailable | 503 | The service is not available right now. |
Authentication
Create and send an API key.
Report affiliate activity
Get separate visit counts, purchase counts, purchase totals and commission totals for each affiliate in an inclusive UTC date range. Purchases use the selected currency (USD by default); visits include all recorded visits. Affiliates with no activity return zeroes. Use next_offset for more affiliates. An affiliate ID outside your account returns ACCESS_DENIED without affiliate or activity details.