Ingest API Reference

The Ingest API is the data collection interface used by game engine plugins and custom integrations to send sessions, events, uploads, and bug reports to Forge Logger.

Base URL

https://ingest.forgelogger.dev

All paths below are relative to this base URL.

Authentication

Every request must include a Logger Token in the Authorization header:

Authorization: Bearer flg_your_token_here

Tokens are scoped to a specific project and environment. Create them in the dashboard under Settings or via the management API.

Endpoints

MethodEndpointDescription
POST/v1/ingest/sessionsStart a new game session
POST/v1/ingest/eventsSubmit telemetry events (single or batch)
POST/v1/ingest/uploadsCreate a pre-signed upload URL
POST/v1/ingest/reportsSubmit a bug report
GET/healthHealth check

Typical flow

  1. Start a session — call /sessions when the game launches. Cache the returned sessionId.
  2. Send events — stream telemetry events to /events during gameplay.
  3. Upload files — when a bug report needs attachments, create upload targets via /uploads, then PUT the binary to the pre-signed URL.
  4. Submit a report — send the bug report to /reports referencing the session, events, and uploads.

Enums

These enum values are shared across all ingest endpoints:

EnumValues
Severitylow, medium, high, critical
Reporter typeplayer, tester, qa, internal, system
Attachment typescreenshot, video, save_state, log_bundle, other
Build channeldev, qa, alpha, beta, staging, prod
Export providergithub, gitlab, jira, discord, webhook

Error handling

The API returns standard HTTP status codes:

CodeMeaning
201Resource created successfully
400Validation error — check the response body for details
401Missing or invalid token
403Token does not have access to this project/environment
429Rate limited — implement exponential back-off
500Server error — retry with back-off

Notes

  • IdempotencyPOST /reports supports an optional clientRequestId (UUID) for idempotent submissions.
  • Batch eventsPOST /events accepts a single object or an array of up to 200 events.
  • Token prefix — all logger tokens start with flg_. Dashboard JWT tokens are not accepted.