The Shake REST API is built for teams that want to do more with their data. While the Shake dashboard is great for daily work, the API allows your developers to pull data directly into your own internal tools, create custom reports, or automate how you handle team members and issues. The REST API is exclusively available to customers on the Organization plan.
1. Authentication
To start, you need an API Key. You can find this in your Shake dashboard under Workspace Settings. For security, keep this key private.
All requests must include this key in the header: X-API-KEY: your_api_key_here
2. Base URL
Your requests should be sent to the following address: https://dashboard-api.shakebugs.com/api/rest
3. What can you do with the API?
The API is divided into three main areas to help you stay organized:
Accounts: Automatically manage your team and control who has access to your workspace.
Crash Reporting: Access deep technical data from crash groups and events, including chat history with users.
Issue Tracking: Manage the full lifecycle of bug reports and user feedback without manually opening the dashboard.
4. Rules of the Road (Rate Limits)
To keep the service fast and reliable for everyone, we have a standard rate limit:
Limit: 200 requests per hour.
Monitoring: Every response from our server tells you exactly how many requests you have left via the
x-ratelimit-remainingheader.
5. Pagination & Technical Specs
When you're fetching lists of data, use limit (max 100) and offset to navigate through your records.
For the complete technical specification and to test endpoints interactively, visit our documentation page: docs.shakebugs.com/docs/rest-api/overview/
Have a question about app installs that is not answered here? Contact us through the Intercom bubble.
Or even better, join our Slack Community and get in touch with our developers within a few minutes.