Introduction

​

Base URL

https://app.gaintrace.com/api/v1

​

What you can do

• Accounts — list your workspace’s accounts with health, ARR, plan, and owner.
• Signals — read open signals, or record your own against an account.
• Product events — push Segment-style usage events that feed health, signals, and activation.
• Metric events — push typed, idempotent events into the metrics engine.

​

Response format

{
  "data": [],
  "meta": { "limit": 50, "offset": 0, "count": 50 }
}

{
  "error": {
    "code": "forbidden",
    "message": "Insufficient scope: read:companies required",
    "doc_url": "https://docs.gaintrace.com/errors#forbidden"
  }
}

​

Conventions

• Pagination: limit (default 50, max 100) and offset on list endpoints.
• Errors: every failure returns error.code, error.message, and error.doc_url. Codes are stable and map one-to-one to an HTTP status. See Errors.
• Idempotency: event ingest dedupes on an id you provide (source_event_id or externalId), so retries are safe.