Web Application Endpoints

BugSplat provides RESTful web services to access data on our backend. The BugSplat database should be selected using the "database" URL parameter. Data is returned in JSON format. Authentication is required for all endpoints. See the curl example at the end of this page for an illustration of this process.

Want to see our API in action? Open your web browser inspector to see how our web application uses the endpoints below!

Most API endpoints support a "database={name}" parameter to specify which BugSplat database to use. Without this parameter, the current (default) database will be selected.

ChartingCompanyCrashCrashesCrash GroupsDatabasesDefectEventsUser (GDPR)UsersVersions

Curl Example

You can access the web services with a variety of tools. Here’s an example using Curl to connect to the Fred database:

rm cookies.txt
curl -b cookies.txt -c cookies.txt --data "email=[e-mail]&password=Flintstone" https://app.bugsplat.com/api/authenticatev3
curl -b cookies.txt -c cookies.txt "https://app.bugsplat.com/allCrash?database=Fred"
curl -b cookies.txt -c cookies.txt "https://app.bugsplat.com/api/crash/data?id=58464&database=Fred"

Escaping special characters in email and password fields can be challenging. If your authentication isn't working, try posting to httpbin.org/post and check the parameters that are returned. You may need to URL-encode the email and password values. For example:

curl --data "email=[e-mail]&password=ABCHi&898S$QQ" https://httpbin.org/post

Postman Collection

Several of our API endpoints can be tested via our public Postman collection.

First, click the top-level BugSplat collection folder, select the Variables tab, and input variables as necessary. You can make most requests automatically by providing values for client_idand client_secret generated on our Integrations page.

For requests requiring additional permissions, you'll need to run the Admin/Authenticate request. Clear your Postman cookies before switching from OAuth2 to Admin/Authenticate.

Special Rules for POST Requests

When POSTing data to BugSplat endpoints, additional steps are required to meet our Cross-Site Request Forgery (XSRF) safety checks. After authenticating, you will receive a cookie named xsrf-token. Send the xsrf-token key/value as a header in all POST requests.