> For the complete documentation index, see [llms.txt](https://docs.pullbay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pullbay.com/documentation/reference/glossary.md). # Glossary A comprehensive reference of terminology used throughout Pullbay documentation and the API. *** ## A ### API Key A unique authentication credential used to authorize API requests. Pullbay issues API keys with prefixes indicating their environment: `test_` for testing/development and `live_` for production use. API keys should be kept secret and never shared publicly. See [Authentication](broken://pages/a2afb2e3aa396aba3a78464d193859bb4918037d) for usage examples. ### Auto-reload An automatic credit replenishment feature that purchases additional credits when your balance falls below a specified threshold. Useful for preventing service interruptions due to unexpected usage spikes. Configure auto-reload in your dashboard under **Billing → Auto-reload Settings**. *** ## B ### Base URL The root endpoint for all Pullbay API requests: `https://api.pullbay.com/v1`. All API calls are made relative to this base URL. For example: `GET https://api.pullbay.com/v1/app-store/reviews`. ### Bearer Token The authentication method used by Pullbay. Include your API key in the HTTP Authorization header as a Bearer token: ```bash Authorization: Bearer YOUR_API_KEY ``` See [Authentication](broken://pages/a2afb2e3aa396aba3a78464d193859bb4918037d) for details. *** ## C ### Circuit Breaker A fault-tolerance pattern used by Pullbay to handle cascading failures. When a data source becomes unreliable, the circuit breaker temporarily stops requests to that source, preventing repeated failures. The circuit automatically closes (resumes) once the source recovers. Learn more in [Error Handling](broken://pages/99c9f15659c74abaa6eca2e8ac0ac40ba366278c). ### Credit The billing unit for Pullbay API requests. Each successful API call consumes a certain number of credits based on the data returned. Credits are prepaid and deducted from your account balance. See [Credits](broken://pages/772b92a9f825a60c9fc9e576d8c5d2a9b38b56ad) for detailed information on consumption, costs, and management. ### Credit Balance The number of credits currently available in your Pullbay account. This is displayed in your dashboard and in the `X-Credits-Remaining` response header. When balance reaches zero, API requests are rejected until you add more credits. ### Cursor An opaque string used for pagination in Pullbay API responses. Cursors represent a position in a dataset and are used with the `cursor` parameter to fetch the next page of results. Cursors should be treated as strings and not parsed or modified. See [Pagination](broken://pages/577452ca452bbd94f48afb0ddabc47aa40d2ce99) for usage. *** ## D ### Degraded Status A temporary reduction in service quality, typically due to upstream platform changes or maintenance. When Pullbay experiences degraded status, endpoints may return partial results or experience higher-than-normal latency. Check the [status page](https://status.pullbay.com/) for real-time status updates. *** ## E ### Endpoint A specific API path that provides access to data from a particular source or service. For example, `/app-store/reviews` is an endpoint that returns reviews for an iOS app. Each endpoint has its own parameters, response format, and credit cost. See [Endpoints](broken://pages/4c62bc5d5f8795e93d8f64bed37553d05465caf7) for a complete list. ### Exponential Backoff A retry strategy that increases the wait time between failed request attempts exponentially (1s, 2s, 4s, 8s, etc.). Pullbay SDKs implement exponential backoff automatically, but manual implementations should follow this pattern to respect rate limits and avoid overwhelming the API. Learn more in [Rate Limiting](broken://pages/8559699d76c80b74572c0fcb24e6aecfa9dcd6a2). *** ## I ### Idempotency A property of API requests where making the same request multiple times produces the same result as making it once. Pullbay API requests are generally idempotent—retrying a failed request will not cause duplicate data or unintended side effects. Include the `Idempotency-Key` header for extra assurance with critical operations. *** ## J ### JSON Schema A standardized format for describing the structure of JSON data. Pullbay API responses conform to published JSON schemas, ensuring consistent structure across all responses. Schemas define required fields, data types, and validation rules. See [API Reference](broken://pages/e3459f802442ef3def26b5331d43285b7193143b) for endpoint-specific schemas. *** ## M ### Managed Pagination An automatic pagination mode provided by Pullbay where the API automatically aggregates all available data and returns it in a single response. Accessible via `/all` endpoint variants (e.g., `/app-store/reviews/all`). This mode simplifies data collection but consumes more credits based on total data volume. Compare to Standard Pagination. See [Pagination](broken://pages/577452ca452bbd94f48afb0ddabc47aa40d2ce99). *** ## P ### Partial Success A response state where an API request succeeds in returning some data but encounters errors for other portions. For example, if you request reviews for multiple apps and one source fails, the response includes successful data along with error information for the failed source. Credits are charged only for data successfully returned. ### Plan A subscription tier that determines your monthly credit allocation, rate limit, feature access, and support level. Pullbay offers four plans: Free, Starter, Growth, and Scale. See [Plans](broken://pages/9802a8247c184f470d22e1b79fb390c6d9005fed) for details on each tier. *** ## R ### Rate Limit A restriction on the maximum number of API requests you can make per minute, determined by your subscription plan. Free plans allow 10 requests/minute, while Scale plans allow 1,000+ requests/minute. Exceeding your rate limit returns a `429 Too Many Requests` response. See [Rate Limiting](broken://pages/8559699d76c80b74572c0fcb24e6aecfa9dcd6a2). ### Request ID A unique identifier (`meta.request_id`) assigned to each API request for tracking and debugging purposes. Request IDs are included in every API response and are useful for referencing specific requests in support tickets or logs: ```json { "meta": { "request_id": "req_1681234567890", "status": "success" } } ``` *** ## S ### Service A category of related data sources organized within Pullbay. Currently, the **Apple App Store** service provides access to app reviews, ratings, metadata, and pricing. Additional services (Google Play Store, etc.) are planned. Each service has multiple endpoints, each with its own data structure and credit cost. ### Standard Pagination A pagination mode where the API returns a limited number of items per request and provides pagination controls (limit, offset, cursor) to fetch additional pages. Allows granular control over data retrieval but requires multiple requests. Compare to Managed Pagination. See [Pagination](broken://pages/577452ca452bbd94f48afb0ddabc47aa40d2ce99). *** ## T ### Test vs. Live Environment Pullbay API keys are prefixed to indicate their environment. `test_` keys are for development and testing; requests to test keys use test data and don't consume real credits. `live_` keys are for production use and consume real credits. Never use live keys in development or shared repositories. *** ## Additional Resources * [API Reference](broken://pages/e3459f802442ef3def26b5331d43285b7193143b) — Complete endpoint documentation * [Authentication](broken://pages/a2afb2e3aa396aba3a78464d193859bb4918037d) — API key management and Bearer token usage * [Error Handling](broken://pages/99c9f15659c74abaa6eca2e8ac0ac40ba366278c) — Understanding error responses and troubleshooting * [Rate Limiting](broken://pages/8559699d76c80b74572c0fcb24e6aecfa9dcd6a2) — Managing request rates and backoff strategies * [Pagination](broken://pages/577452ca452bbd94f48afb0ddabc47aa40d2ce99) — Fetching data across multiple pages * [Status Page](https://status.pullbay.com/) — Real-time service status and incidents --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.pullbay.com/documentation/reference/glossary.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.