Publishing APIs
Subscribers, analytics and revenue
Who uses your API, how, and what it earns.
Community: your subscribers
Community lists everyone subscribed to your API, with their plan, the date subscribed and their requests this period.
- Block a subscriber to stop their calls immediately (the gateway rejects them) without cancelling their subscription; unblock to restore access. Use it for abuse or unpaid disputes.
- Invite To Private Plan sends a customer an invitation to a hidden plan (details).
- Message subscribers sends a private message to the subscribers you select. It arrives in their Inbox, and they can reply. Use it for new endpoints, deprecations and maintenance windows.
Analytics
Studio → Analytics covers all of your APIs:
- API calls, published APIs, active days and success rate, over the period you choose;
- a chart of calls over time;
- Top APIs by usage;
- subscriber metrics: active APIs, active subscriptions and total subscribers.
Logs
Each API's Logs section shows every call to it: time, endpoint, method, status, latency, error code and the consumer's username and location. Filter by endpoint, status and date range, or search by username. Open a call to see its request headers, query parameters and body, and the response headers and body, which is invaluable when a consumer reports a problem (they can give you the request ID). Export CSV downloads the filtered list.
Revenue
Each API's Revenue section shows:
- Gross revenue: what consumers paid for this API;
- Net payout: what you receive;
- Total transactions;
- a table of every payment, with its status and estimated payout date, which you can filter, search and Export CSV.
Earnings are paid monthly, in arrears, in the first week of the month after next (August earnings are paid in the first week of October). We send the money manually by PayPal, so add your PayPal email under Settings → Profile. Questions about a payout? Contact [email protected].
Public health metrics
Your listing shows popularity, service level (the share of successful calls) and latency, calculated from the last 30 days of real traffic through the gateway. Keeping your server fast and reliable improves how your API is ranked in the Popular and Recommended collections.
Something unclear or missing? Email [email protected].