API Reference

Base URL

https://api.traceway.dev/v1

All endpoints are prefixed with this base URL. API versioning is handled via the URL path — breaking changes will increment the version to /v2.

Authentication

[PLACEHOLDER: Confirm authentication mechanism. Expected: API key passed as a header — likely Authorization: Bearer YOUR_API_KEY or a custom X-API-Key: YOUR_API_KEY header. API keys are generated per project in the Traceway dashboard.]

All requests require a valid API key. Requests without a valid key return:

{
  "error": "unauthorized",
  "message": "A valid API key is required."
}

Request format

All request bodies must be JSON. Set the Content-Type header:

Content-Type: application/json

Response format

All responses return JSON. Successful responses return the resource directly. Errors return an object with error and message fields.

Rate limiting

[PLACEHOLDER: Confirm rate limit values. Expected: per-project limits on issue submission, standard limits on read endpoints. Document the response headers used to communicate limit status — likely X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.]

Pagination

[PLACEHOLDER: Confirm pagination strategy — likely cursor-based or offset/limit. Document the query parameters and response envelope shape.]

SDK vs direct API

Most applications should use the Flutter SDK rather than calling the API directly. The SDK handles authentication, automatic metadata capture, retry logic, and offline queuing.

Use the API directly when:

• Integrating from a platform without an SDK
• Building custom tooling or automations
• Submitting reports from a backend service

Endpoints

• Authentication — API keys and auth headers
• Issues — submit and retrieve issue reports
• Projects — project metadata and configuration
• Errors — error code reference