Skip to main content

Launcher

Launcher operations are used by the game launcher client to check API availability, report events, send hardware profiles, and submit crash reports.

Health check​

QuerydocumentId: healthauth: launcher key

health​

Description​

Checks launcher API availability.

Input​

The operation does not accept variables.

Result​

Response type - Boolean!.

Errors​

  • PROJECT_NOT_FOUND - project was not found.
  • LAUNCHER_DISABLED - launcher API is disabled.

Exchange example​

Request
documentId: health
{
  "documentId": "health",
  "variables": {}
}
Response
200 OK
{
  "data": {
    "health": true
  }
}
Launcher reference

Launcher event​

MutationdocumentId: reportLauncherEventauth: launcher key

reportLauncherEvent​

Description​

Reports a launcher event such as launch, login, download start, download finish, or another client action.

Input​

FieldTypeRequiredDescription
launcherKeyString!✓Launcher key
launcherIdString-Installed client ID
eventString!✓Event name
launcherVersionString-Launcher version
payloadJSON-Additional event data

Result​

Response type - Boolean!.

Errors​

  • VALIDATION - required fields are missing.
  • INVALID_LAUNCHER_KEY - launcher key is invalid.

Exchange example​

Request
documentId: reportLauncherEvent
{
  "documentId": "reportLauncherEvent",
  "variables": {
    "launcherKey": "launcher-key",
    "launcherId": "launcher-id",
    "event": "launcher_opened",
    "launcherVersion": "1.0.0",
    "payload": {}
  }
}
Response
200 OK
{
  "data": {
    "reportLauncherEvent": true
  }
}
Launcher reference

Hardware profile​

MutationdocumentId: reportHardwareauth: launcher key

reportHardware​

Description​

Reports a device hardware profile for diagnostics, protection, and support.

Input​

FieldTypeRequiredDescription
launcherKeyString!✓Launcher key
hardwareJSON!✓Hardware profile

Result​

Response type - Boolean!.

Errors​

  • VALIDATION - hardware profile is missing.
  • INVALID_LAUNCHER_KEY - launcher key is invalid.

Exchange example​

Request
documentId: reportHardware
{
  "documentId": "reportHardware",
  "variables": {
    "launcherKey": "launcher-key",
    "hardware": {
      "cpu": "Intel Core",
      "gpu": "NVIDIA",
      "ram": 16
    }
  }
}
Response
200 OK
{
  "data": {
    "reportHardware": true
  }
}
Launcher reference

Crash report​

MutationdocumentId: reportCrashauth: launcher key

reportCrash​

Description​

Reports a launcher or game client crash.

Input​

FieldTypeRequiredDescription
launcherKeyString!✓Launcher key
crashJSON!✓Crash data

Result​

Response type - Boolean!.

Errors​

  • VALIDATION - crash data is missing.
  • INVALID_LAUNCHER_KEY - launcher key is invalid.

Exchange example​

Request
documentId: reportCrash
{
  "documentId": "reportCrash",
  "variables": {
    "launcherKey": "launcher-key",
    "crash": {
      "message": "Unhandled exception",
      "stack": "stack trace",
      "launcherVersion": "1.0.0"
    }
  }
}
Response
200 OK
{
  "data": {
    "reportCrash": true
  }
}
Launcher reference