Gameball Developers Guide
v4.0
v4.0
  • Introduction
  • Installing Gameball
    • Web
      • Initialize Gameball Customer Widget
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Go-Live Checklist
    • iOS
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Push Notifications
      • Track Referrals
      • Go-Live Checklist
    • Android
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Push Notifications
      • Go-Live Checklist
    • React Native
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • Flutter
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Go-Live Checklist
    • Generic Mobile App
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
  • REST API
    • Overview
      • What's New in V4.0
      • Authentication
      • Rate Limiting
      • Status and Error Codes
    • Customers
      • Customer Management
      • Customer Progress
      • Customer Tags
      • Customer Notifications
    • Events
    • Order
      • Order Tracking
      • Order Rewards & History
    • Payment
      • Payment Tracking
    • Transactions
      • Cashback & Redemptions
      • Hold Management
      • Transaction Management
      • Transaction Validation
    • Coupons
    • Configurations
      • Reward Configurations
      • Program Configurations
      • Widget Configuration
    • Leaderboard
    • Batches
      • Batch Creation
      • Batch Management
  • Webhooks
    • Overview
    • Subscribing to Webhooks
    • Webhook Topics
      • Customer's Notifications
      • Customer's Profile Updates
  • Tutorials
    • Tracking Customer Events
    • Redemption Integration
      • Direct debit redemption
      • Coupons Redemption
        • Use Your Own Couponing Engine
        • Gameball Couponing Engine
    • Checkout Integration
    • Build Custom UI Elements
      • Reward Campaigns
      • VIP Tiers
      • Customer Balance
      • Widget Configurations
      • Coupons Customer Experience
      • Customer Notifications
      • Customer Leaderboard
    • Build your Own Notification System
    • Channel Merging Guide
    • Previewing Potential Points Before Purchase
    • Refund
    • Retail & POS Integration with Gameball Loyalty Program
    • Referrals
    • Widget Deep Links
    • Batch APIs usage example
  • Branch.io Integration
  • Adjust Integration
Powered by GitBook
On this page
  1. REST API
  2. Overview

Rate Limiting

Gameball API employs safeguards to protect against sudden bursts of traffic, ensuring platform stability. If you send too many requests in a short time, you may encounter error responses with status code 429 (Too Many Requests).

Rate Limits: Gameball uses two levels of rate limiting:

  • Per-second limit: A maximum of read and write operations operations can be processed per second. This is the limit for concurrent requests handled at any given moment.

  • Per-30s quota: Over the course of 30 seconds. This acts as an overall cap to ensure the system remains stable during sustained activity.

Rate Limits Overview

Gameball API uses rate limiting to manage traffic across its endpoints. Instead of applying a uniform limit, the system uses distinct rate and quota "buckets" for different API resources and operations. This allows flexibility and ensures optimal system performance tailored to the specific needs of each resource.

The rate defines the maximum number of requests allowed per second for a resource, while the quota specifies the total number of requests allowed within a 30-second window. Below is a detailed breakdown of the rate limits for each resource:

API Resource
Method
Rate (requests/second)
Quota (requests/30 seconds)

Transactions

GET

30

360

POST

30

360

Coupons

All

30

360

POST

30

360

Customers

GET

100

1200

POST

30

360

Events

Any

100

1200

Orders (Tracking)

Any

30

360

Orders (Cashback)

Any

1000

15,000

Others

Any

30

360

If the rate exceeds either the per-second or per-30s limit, a 429 Too Many Requests error will be returned.

To handle bulk operations and avoid hitting API rate limits, batch APIs will be released by the end of Q4 2024, allowing you to process multiple requests more efficiently.

Common Causes and Mitigations:

Rate limiting can occur for several reasons, with the most common scenarios being:

  • High request volume in quick succession: Sending many closely-timed requests, such as during large data analysis or migration, can lead to rate limiting. To avoid this, control the request rate from your side (see Handling Rate Limiting Gracefully).

  • Sudden spikes in traffic (e.g., flash sales): A sudden influx of requests, like during a flash sale, can cause rate limiting. While the API limits are designed to accommodate typical traffic, you may want to prepare in advance for events expected to generate a surge in requests.

PreviousAuthenticationNextStatus and Error Codes

Last updated 5 months ago