Skip to main content
GET
Get analyse settings

Authorizations

Authorization
string
header
required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

projectTemplateUid
string
required

Project template UID

Response

OK

Base analyseSettingsDto

type
enum<string>
required

Response differs based on analyse type: PreAnalyse (source segments analysis), PostAnalyse (machine translation post-editing analysis), PreAnalyseTarget (target segments analysis) or Compare (compares word/character counts across workflow levels)

Available options:
PreAnalyse,
PostAnalyse,
PreAnalyseTarget,
Compare
allowAutomaticPostAnalysis
boolean

If automatic post analysis should be created after update source. Default: false

analyzeByLanguage
boolean

When true, creates one analysis per target language instead of a single combined analysis. Default: false

analyzeByProvider
boolean

When true, creates one analysis per assigned provider instead of a single combined analysis. Default: false

countSourceUnits
boolean

Whether the analysis counts source or target word/character units. When true, counts are based on the source language content; when false, counts are based on the target language content. Default: false

includeConfirmedSegments
boolean

When true, confirmed (translated) segments are included in the counts. Default: false

includeLockedSegments
boolean

When true, locked segments are included in the counts. Default: false

includeNotConfirmedSegments
boolean

When true, not confirmed segments are included in the counts. Default: false

includeNumbers
boolean

When true, number-only segments are included in the counts. Default: false

includeTransMemory
boolean

When true, translation memory matches are included in the counts. Default: false

namingPattern
string