resources/statistics/ba

Gets a business analytical view on edits of a document for a specific target language.

Provides details on:

Who edited how many text
Time spent with translations and edits
Quality metrics

URL

(POST) /resources/statistics/ba

PARAMETERS

The message body contains a JSON object:

scope	The scope object. Note that if you use a document set or global search scope, you will receive an "available" = false result. In fact these scopes do not support files.
did	The document id. This must be a document within the scope.
locale	The language to get statistics for.

RESULTS

The message body contains a JSON object:

segments	An object with various segment counts: total: Total error: With error status ok: With OK status missing: Without translation filled: With translation
words	An object with various word counts: total: Total error: With error status ok: With OK status missing: Without translation filled: With translation
dtfirst	First edit date in document. Null if none.
dtfirstt	First edit date as a string.
dtlast	Last edit date in document. Null if none.
dtlastt	Last edit date as a string.
scores	An array of document level scores. See table below.
editors	Provides statistics per "last editor" (human edit, pre-translation, MT, etc.). See table below.
workers	Provides statistics per worker who edited at least one segment. See table below.

Editors node

The editors element is an array of objects with these properties.

Note that the last array element contains the grand totals.

editor	An internal code for the type of editor.
title	Title of editor.
segments	An object with various segment counts: initial: Total that had this editor initially (when marking a document for translation) current: Total that have this editor now. unchanged: Total that had this editor and still have now. translation: Total translated. postEditing: Total post edited. revision: Total revised
words	An object with various word counts: initial: Total that had this editor initially (when marking a document for translation) current: Total that have this editor now. unchanged: Total that had this editor and still have now. translation: Total translated. postEditing: Total post edited. revision: Total revised
actions	Total of interventions
actionsCorrections	Total of interventions correcting a previous text
scores	An array of document level scores. See table below.

Workers node

The workers element is an array of objects with these properties.

Note that the last array element contains the grand totals.

pid	Person ID. Null if current user is not authorized to see this.
cid	Company ID. Null if current user is not authorized to see this.
pname	Person name. Null if current user is not authorized to see this.
pcode	Person code. Null if current user is not authorized to see this.
cname	Company name. Null if current user is not authorized to see this.

segments	An object with various segment counts: total: Total texts edited by this person corrected: Total texts edited by this person and which were subsequently corrected/edited by someone else. translation: Total texts translated by user from scratch. postEditing: Total texts post-edited by user (from a memory or MT pre-translation). revision: Total texts revised by user (i.e. user edited a human translation/edit done by someone else)
words	An object with various word counts: total: Total texts edited by this person corrected: Total texts edited by this person and which were subsequently corrected/edited by someone else. translation: Total texts translated by user from scratch. postEditing: Total texts post-edited by user (from a memory or MT pre-translation). revision: Total texts revised by user (i.e. user edited a human translation/edit done by someone else)
dtfirst	First edit date in document.
dtfirstt	First edit date as a string.
dtlast	Last edit date in document.
dtlastt	Last edit date as a string.
scores	An array of document level scores. See table below.

Scores node

Each scores element contains an array of objects with these properties:

title	Print title for score.
value	Decimal value of score. Can be null if score could not be calculated (lack of data)
unit	Null or the unit of the score. For example "%" with percentages.
desc	A description of the score and its purpose. Note that this text adapts to the actual score value.
max	The maximum value the score can have.

ACCESS CONTROL

Note that the logged user must have access to BA data.

See the resource rights, property canViewBA which must be true.

EXAMPLES

See this example:

{
  "segments": {
    "error": 0,
    "ok": 0,
    "missing": 0,
    "filled": 4,
    "total": 4
  },
  "words": {
    "error": 0,
    "ok": 0,
    "missing": 0,
    "filled": 8,
    "total": 8
  },
  "dtfirst": "2017-02-06T07:09:09.8944871Z",
  "dtlast": "2017-02-06T07:09:22.4785955Z",
  "dtfirstt": "06/02/2017 08:09 UTC+1",
  "dtlastt": "06/02/2017 08:09 UTC+1",
  "editors": [
    {
      "editor": "None",
      "title": "Not translated",
      "segments": {
        "initial": 4,
        "unchanged": 0,
        "translation": 4,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "words": {
        "initial": 8,
        "unchanged": 0,
        "translation": 8,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "Actions": 4,
      "ActionsCorrections": 0,
      "scores": [
        {
          "title": "Work quality",
          "value": 10.0,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    },
    {
      "editor": "RefMaterialIdentical",
      "title": "Pre-translation Exact",
      "segments": {
        "initial": 0,
        "unchanged": 0,
        "translation": 0,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "words": {
        "initial": 0,
        "unchanged": 0,
        "translation": 0,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "Actions": 0,
      "ActionsCorrections": 0,
      "scores": [
        {
          "title": "Work quality",
          "value": null,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    },
    {
      "editor": "RefMaterialFuzzy",
      "title": "Pre-translation Fuzzy",
      "segments": {
        "initial": 0,
        "unchanged": 0,
        "translation": 0,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "words": {
        "initial": 0,
        "unchanged": 0,
        "translation": 0,
        "postEditing": 0,
        "revision": 0,
        "current": 0
      },
      "actions": 0,
      "actionsCorrections": 0,
      "scores": [
        {
          "title": "Work quality",
          "value": null,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    },
    {
      "editor": null,
      "title": "TOTAL",
      "segments": {
        "initial": 4,
        "unchanged": 0,
        "translation": 4,
        "postEditing": 0,
        "revision": 0,
        "current": 4
      },
      "words": {
        "initial": 8,
        "unchanged": 0,
        "translation": 8,
        "postEditing": 0,
        "revision": 0,
        "current": 8
      },
      "actions": 4,
      "actionsCorrections": 0,
      "scores": [
        {
          "title": "Work quality",
          "value": 10.0,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    }
  ],
  "workers": [
    {
      "pid": 7,
      "cid": 1,
      "pname": "Stephan Bohmig",
      "pcode": "SB",
      "cname": "Pons",
      "segments": {
        "total": 4,
        "translation": 4,
        "postEditing": 0,
        "revision": 0,
        "corrected": 0
      },
      "words": {
        "total": 8,
        "translation": 8,
        "postEditing": 0,
        "revision": 0,
        "corrected": 0
      },
      "dtfirst": "2017-02-06T07:09:09.8944871Z",
      "dtlast": "2017-02-06T07:09:22.4785955Z",
      "dtfirstt": "06/02/2017 08:09 UTC+1",
      "dtlastt": "06/02/2017 08:09 UTC+1",
      "scores": [
        {
          "title": "Work quality",
          "value": 10.0,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    },
    {
      "pid": 0,
      "cid": 0,
      "pname": "TOTAL",
      "pcode": "TOTAL",
      "cname": null,
      "segments": {
        "total": 4,
        "translation": 4,
        "postEditing": 0,
        "revision": 0,
        "corrected": 0
      },
      "words": {
        "total": 8,
        "translation": 8,
        "postEditing": 0,
        "revision": 0,
        "corrected": 0
      },
      "dtfirst": "2017-02-06T07:09:09.8944871Z",
      "dtlast": "2017-02-06T07:09:22.4785955Z",
      "dtfirstt": "06/02/2017 08:09 UTC+1",
      "dtlastt": "06/02/2017 08:09 UTC+1",
      "scores": [
        {
          "title": "Work quality",
          "value": 10.0,
          "unit": null,
          "desc": null,
          "max": 10.0
        }
      ]
    }
  ],
  "scores": [
    {
      "title": "Completed",
      "value": 100.0,
      "unit": "%",
      "desc": "Percentage translations supplied and not marked errorneous.",
      "max": 0.0
    },
    {
      "title": "Human translation quality",
      "value": 10.0,
      "unit": null,
      "desc": "0 out of 4 human translated or post-edited segments required correction.",
      "max": 10.0
    },
    {
      "title": "Pre-translated",
      "value": null,
      "unit": "%",
      "desc": "No segments are pre-translated by machine or from memories to calculate score.",
      "max": 0.0
    },
    {
      "title": "Pre-translation quality",
      "value": null,
      "unit": null,
      "desc": "No segments are pre-translated by machine or from memories to calculate score.",
      "max": 10.0
    },
    {
      "title": "Overall Efficiency",
      "value": 5.0,
      "unit": null,
      "desc": "4 segments required a total of 4 human interventions.",
      "max": 10.0
    }
  ]
}