Glossary of Terms
- API: Application Programming Interface
- Bearer Token: An authentication token used to access protected resources
- Conversion: A completed goal action on your website (e.g., a purchase)
- Microconversion: A smaller engagement action that precedes a conversion
- ROAS: Return on Advertising Spend
- UTM Parameters: Tracking parameters added to URLs (utm_source, utm_medium, etc.)
- Pagination: The process of dividing large datasets into smaller chunks or pages
- Endpoint: A specific URL that represents an API function or resource
Status Codes
- 200 OK: The request was successful
- 400 Bad Request: The request was invalid or cannot be served
- 401 Unauthorized: Authentication is required or has failed
- 403 Forbidden: The server understood the request but refuses to authorize it
- 404 Not Found: The requested resource could not be found
- 429 Too Many Requests: Rate limit exceeded
- 500 Internal Server Error: An error occurred on the server
Rate Limits
The API Seal Metrics implements rate limiting to ensure fair usage and system stability:
- Starter Plan**: 0 requests per minute
- Growth Plan**: 1 request per day
- Enterprise Plan**: 1 request per minute
You'll receive a 429 Too Many Requests response if you exceed these limits. To handle rate limiting gracefully, implement proper retry logic with exponential backoff.
Changelog
Version 1.0 (Current)
- Initial release of the API Seal Metrics
- Support for all core analytics endpoints
- Authentication via Bearer token
- JSON response format for all endpoints