Get LQA Assessment

curl --request GET \
  --url https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid} \
  --header 'Authorization: <api-key>'

import requests

url = "https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "assessmentJobPartUid": "<string>",
  "assessmentResult": {
    "issueCounts": {
      "critical": 0,
      "criticalRepeated": 0,
      "major": 1,
      "majorRepeated": 0,
      "minor": 3,
      "minorRepeated": 1,
      "neutral": 0,
      "neutralRepeated": 0
    },
    "jobPart": {
      "uid": "3HYnHHLkTPJfMxBCDbPXFe"
    },
    "status": "PASS",
    "score": 94.5
  },
  "editedDate": "2023-11-07T05:31:56Z",
  "finishedDate": "2023-11-07T05:31:56Z",
  "jobPartUid": "<string>",
  "lqaEnabled": true,
  "lqaProfile": {
    "dateCreated": "2024-03-15T09:00:00Z",
    "errorCategories": {
      "accuracy": {
        "accuracy": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "addition": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "improperTmMatch": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "mistranslation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "omission": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "overTranslation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "underTranslation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "untranslated": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "design": {
        "design": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "length": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "localFormatting": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "markup": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "missingText": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "truncation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "fluency": {
        "characterEncoding": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "crossReference": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "fluency": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "grammar": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "grammaticalRegister": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "inconsistency": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "punctuation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "spelling": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "localeConvention": {
        "addressFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "currencyFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "dateFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "localeConvention": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "measurementFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "shortcutKey": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "telephoneFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "other": {
        "other": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "style": {
        "awkward": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "companyStyle": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "inconsistentStyle": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "style": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "thirdPartyStyle": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "unidiomatic": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "terminology": {
        "inconsistentUseOfTerminology": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "inconsistentWithTb": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "terminology": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "verity": {
        "cultureSpecificReference": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "verity": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      }
    },
    "isDefault": true,
    "name": "<string>",
    "organization": {
      "uid": "3HYnHHLkTPJfMxBCDbPXFe"
    },
    "passFailThreshold": {
      "minScorePercentage": 99
    },
    "penaltyPoints": {
      "critical": {
        "code": 123,
        "value": 123
      },
      "major": {
        "code": 123,
        "value": 123
      },
      "minor": {
        "code": 123,
        "value": 123
      },
      "neutral": {
        "code": 123,
        "value": 123
      }
    },
    "uid": "LqP8kMckeDcg"
  },
  "overallFeedback": "<string>",
  "reportCanBeDownloaded": true,
  "requestedJobPartUid": "<string>",
  "reviewProvider": {
    "organizationUid": "<string>",
    "uid": "<string>"
  },
  "startedDate": "2023-11-07T05:31:56Z",
  "translationProvider": {
    "uid": "3HYnHHLkTPJfMxBCDbPXFe"
  },
  "workflowStep": {
    "abbr": "<string>",
    "id": "<string>",
    "lqaEnabled": true,
    "name": "<string>",
    "order": 123,
    "uid": "<string>"
  }
}

Language Quality Assessment

Get LQA Assessment

Retrieves the Language Quality Assessment (LQA) status and results for a single job. Use this endpoint after a reviewer finishes an LQA workflow step to read the MQM (Multidimensional Quality Metrics)-based score, issue counts by severity, and the pass/fail determination before advancing the job to the next step.

If the requested job is not in an LQA workflow step, the assessment from the nearest successive LQA-enabled step is returned instead.

The caller must have read access to the job’s project. Roles without project visibility receive a 403 response (FORBIDDEN). To resolve a 403, ensure your API token belongs to a user with at least read access to the project containing this job. To resolve a 404 (ResourceNotFound), verify the jobUid is correct and the job has not been deleted or archived.

Note: the example response is abbreviated for readability; the full response includes all fields such as issueCounts (with criticalRepeated, majorRepeated, minorRepeated, neutralRepeated) and lqaProfile (with errorCategories, penaltyPoints, passFailThreshold, dateCreated, organization).

GET

api2

lqa

assessments

{jobUid}

Get LQA Assessment

curl --request GET \
  --url https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid} \
  --header 'Authorization: <api-key>'

import requests

url = "https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://cloud.memsource.com/web/api2/v1/lqa/assessments/{jobUid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "assessmentJobPartUid": "<string>",
  "assessmentResult": {
    "issueCounts": {
      "critical": 0,
      "criticalRepeated": 0,
      "major": 1,
      "majorRepeated": 0,
      "minor": 3,
      "minorRepeated": 1,
      "neutral": 0,
      "neutralRepeated": 0
    },
    "jobPart": {
      "uid": "3HYnHHLkTPJfMxBCDbPXFe"
    },
    "status": "PASS",
    "score": 94.5
  },
  "editedDate": "2023-11-07T05:31:56Z",
  "finishedDate": "2023-11-07T05:31:56Z",
  "jobPartUid": "<string>",
  "lqaEnabled": true,
  "lqaProfile": {
    "dateCreated": "2024-03-15T09:00:00Z",
    "errorCategories": {
      "accuracy": {
        "accuracy": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "addition": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "improperTmMatch": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "mistranslation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "omission": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "overTranslation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "underTranslation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "untranslated": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "design": {
        "design": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "length": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "localFormatting": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "markup": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "missingText": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "truncation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "fluency": {
        "characterEncoding": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "crossReference": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "fluency": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "grammar": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "grammaticalRegister": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "inconsistency": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "punctuation": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "spelling": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "localeConvention": {
        "addressFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "currencyFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "dateFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "localeConvention": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "measurementFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "shortcutKey": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "telephoneFormat": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "other": {
        "other": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "style": {
        "awkward": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "companyStyle": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "inconsistentStyle": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "style": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "thirdPartyStyle": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "unidiomatic": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "terminology": {
        "inconsistentUseOfTerminology": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "inconsistentWithTb": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "terminology": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      },
      "verity": {
        "cultureSpecificReference": {
          "code": 123,
          "enabled": true,
          "weight": 1
        },
        "verity": {
          "code": 123,
          "enabled": true,
          "weight": 1
        }
      }
    },
    "isDefault": true,
    "name": "<string>",
    "organization": {
      "uid": "3HYnHHLkTPJfMxBCDbPXFe"
    },
    "passFailThreshold": {
      "minScorePercentage": 99
    },
    "penaltyPoints": {
      "critical": {
        "code": 123,
        "value": 123
      },
      "major": {
        "code": 123,
        "value": 123
      },
      "minor": {
        "code": 123,
        "value": 123
      },
      "neutral": {
        "code": 123,
        "value": 123
      }
    },
    "uid": "LqP8kMckeDcg"
  },
  "overallFeedback": "<string>",
  "reportCanBeDownloaded": true,
  "requestedJobPartUid": "<string>",
  "reviewProvider": {
    "organizationUid": "<string>",
    "uid": "<string>"
  },
  "startedDate": "2023-11-07T05:31:56Z",
  "translationProvider": {
    "uid": "3HYnHHLkTPJfMxBCDbPXFe"
  },
  "workflowStep": {
    "abbr": "<string>",
    "id": "<string>",
    "lqaEnabled": true,
    "name": "<string>",
    "order": 123,
    "uid": "<string>"
  }
}

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

jobUid

string

required

UID of the job to retrieve the LQA assessment for. A base62 alphanumeric string (case-sensitive) as returned by job creation endpoints.

Response

LQA assessment state

assessmentJobPartUid

string

UID of job corresponding to the assessment. Null when assessment not found

assessmentResult

object

Language Quality Assessment (LQA) result for a single job part, including the PASS/FAIL verdict, score, and a breakdown of issue counts by severity.

Show child attributes

availability

enum<string>

Availability state of LQA for this job.

Available options:

NOT_AVAILABLE,

DISABLED_IN_ALL_WORKFLOW_STEPS,

DISABLED_IN_CURRENT_WORKFLOW_STEP,

ENABLED

editedDate

string<date-time>

When assessment was edited after previous finish (or empty)

finishedDate

string<date-time>

When assessment was finished (or empty)

jobPartUid

string

UID of the corresponding job

lqaEnabled

boolean

If LQA is enabled and configured for this job

lqaProfile

object

LQA (Language Quality Assessment) profile snapshot applied to an assessment

Show child attributes

mode

enum<string>

What the assessment captures. ISSUES: error issues only. ISSUES_AND_SCORE: issues plus an MQM (Multidimensional Quality Metrics) score expressed as a percentage.

Available options:

ISSUES,

ISSUES_AND_SCORE

origin

enum<string>

Whether the assessment was performed by a human reviewer or an automated system.

Available options:

HUMAN,

AI

overallFeedback

string

Overall feedback from the LQA reviewer

reportCanBeDownloaded

boolean

If Assessment report/scorecard is ready and can be downloaded, user's rights are considered

requestedJobPartUid

string

The originally requested job UID

reviewProvider

object

Show child attributes

startedDate

string<date-time>

When assessment was started (or empty)

status

enum<string>

Current lifecycle state of the assessment. NOT_STARTED: no assessment exists yet. STARTED: assessment is in progress. FINISHED: scorer has submitted results. FINISHED_WITH_EDITING: finished after a prior edit. EDITED: reviewer edited the submission after finishing.

Available options:

NOT_STARTED,

STARTED,

FINISHED,

FINISHED_WITH_EDITING,

EDITED

translationProvider

object

Reference to an object by its unique identifier

Show child attributes

workflowStep

object

Show child attributes

Discard multiple finished LQA Assessment results Start LQA Assessment

⌘I