Page tree


If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.

Key Performance Indicators (KPI)

URL:

/editor/task/kpi

Available Methods:

POST

Specialities:

  • params (form-data): filter (= taskGrid-filtering, advanced filters)
  • returns JSON with:
    - averageProcessingTime* and excelExportUsage
    - levenshtein and posteditingTime**

Excel with Meta-data and KPI

URL:

/editor/task/kpi?format=xlsx&filter=[FILTER]&visibleColumns=[VISIBLECOLUMNS]

Specialities:

  • format: xlsx
  • filter = taskGrid-filtering
  • visibleColumns = visible columns in taskGrid
  • returns Excel-file with two sheets: (1) taskGrid according to filters and visible columns (2) the filters that have been applied and the resulting KPI

* Sample average processing time response

Without filtering by workflow step(s)With filtering by "workflowStep" property

"averageProcessingTimeTranslator" : "5 days"

"averageProcessingTimeReviewer" : "3 days"

"averageProcessingTimeSecondTranslator" : "0 days"

"byWorkflowSteps" : "reviewing,translation",

"reviewing" : "3 days",

"translation" : "5 days"

** Levenshtein and post-editing time response meaning


Variable name

Meaning

1

levenshteinStart

Levenshtein distance before the start of workflow

2

posteditingTimeStart

Post-editing time before the start of workflow

3

levenshteinPrevious

Levensthein distance within 1 workflow step

4

posteditingTime

Post-editing time within 1 workflow step

5

levenshteinOriginal

Levensthein distance from the start of workflow

6

posteditingTimeTotal

Post-editing time from the start of workflow

7

levenshteinEnd

Levenshtein distance after the end of workflow

8

posteditingTimeEnd

Post-editing time after the end of workflow

For 3-6 variables (values within 1 workflow step and from the start of workflow) more information is provided in KPI window tooltips.


  • No labels