Skip to main content

Multi-Language Support For Investigation Reports

Updated

Overview

Qevlar investigation reports can be returned in languages other than English via a query parameter on the result endpoint. This allows MSSPs and analysts to deliver translated investigation summaries and remediation handoffs directly to non-English speaking customers or teams without any change to the SaaS platform experience, which remains in English.

How it works

Language selection happens in two steps:

  1. When submitting an alert to Qevlar for investigation via POST /v2/investigations, pass a lang query parameter to specify which languages you want the report translated into. You may request up to 3 languages in addition to English.
  2. When retrieving the investigation result via GET /v2/investigations/{alert_id}/result, pass the same lang query parameter to receive the report summary and remediation content in the specified language. The response structure is identical to a standard (English) report. Only the text content is translated.

Note: This feature covers the report summary and remediation handoff only.

 

Endpoints

POST /v2/investigations
 
GET /v2/investigations/{alert_id}/result

Query Parameters

Parameter Type Required Description
lang string No ISO 3166-1 alpha-2 language code for the translated report (e.g. fr). If omitted, the report is returned in English. Only one language per request is supported. When used with POST /v2/investigations, specifies which languages to generate translations for (up to 3). When used with GET /v2/investigations/{alert_id}/result, specifies which translation to retrieve.

 

Common Language Codes

Language Code
French fr
German de
Spanish es
Italian it
Portuguese pt

For a full list of supported codes, see ISO 3166-1 alpha-2.

Response

The translated response has the same JSON structure as a standard report. The report summary and remediation handoff fields are returned in the requested language. All other fields (IDs, timestamps, tags, metadata) remain unchanged.

Error Handling

If you pass a lang parameter, you may receive one of the following errors:

Error Meaning
translation is still in progress The language is supported but the translation for this specific investigation is not yet complete.
Language is not available for this investigation. The requested language was not included in the original POST /v2/investigations request, or the language code is not supported.

If you receive either error, you can always omit the lang parameter to retrieve the original English report.

 

Notes

  • Languages must be specified at alert submission time via POST /v2/investigations. You cannot request a translation for a language that was not included in the original submission. Up to 3 languages (in addition to English) can be requested per alert. Only one language can be retrieved per API call to the result endpoint. HTML report format is not supported. Translation is available for JSON responses only. The Qevlar SaaS platform interface remains in English; this feature applies to API responses only.
  • Up to 3 languages (in addition to English) can be requested per alert. Only one language can be retrieved per API call to the result endpoint. HTML report format is not supported. Translation is available for JSON responses only. The Qevlar SaaS platform interface remains in English; this feature applies to API responses only.
  • Only one language can be retrieved per API call to the result endpoint.
  • HTML report format is not supported. Translation is available for JSON responses only.
  • The Qevlar SaaS platform interface remains in English; this feature applies to API responses only.

Related articles