Versions Compared

Old Version 11

changes.mady.by.user Stephan Böhmig

Saved on

compared with

New Version 12

changes.mady.by.user Stephan Böhmig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

scope

The scope of segments. See Scope (Object).

NOTE: This method supports these scopes only: Project, Job or DocumentSet.  

Example:

Code Block
"scope": { "type": "Project", "projectid": 3343 }


object, Mandatory
query

An optional query object. To filter the segments of the scope.  Example for drilling down on a single document:

Code Block
{ "documents": [{ "did": 9800 }] }}


object?, Optional
groupby

Optional, default is Global.

Internally the system calculates text edits segment by segment. Instead of returning information on every single edit (which may be a lot), the individual data is grouped, i.e. aggregated. For example, with ByUser, one gets the total edits by user over the specified scope and query.

  • Global: Aggregates all edits into a single row
  • ByUser: Returns one row per editing user
  • ByLocale: Returns one row by source/target language couple
  • ByUserAndLocale: Returns one row per user and language couple
  • ByUserAndLocaleAndEditor: Returns one row per user, language couple and last editor
  • ByDocumentAndLocale: Returns one row per document and language couple
  • ByDocumentAndLocaleAndUser: Returns one row per document, language couple and user


string?, Optional
aggregationMode

Optional. default is SingleActionPerUser.

  • SingleActionPerUser: Recommended option. With each source text change, a specific user typically makes a single edit (to write or post edit the translation). If the translation is revised by a different user, the user may again do some further edits. With this mode, we will calculate s single edit per source text change and per user.
  • AllActionsPerUser: Every single user's edit is counted. See description above. 


string?, Optional
dateFrom

Optional. Count edits at or after this date only.

If set, then we only considers edits done at or after this date. This property is useful to calculate edits for periods of time, such as for a full month. This can be used for customized costing of work by user.

datetime?, Optional
dateTo

Optional. Count edits before this date only.

If set, then we only considers edits done before this date. 

datetime?, Optional
srcDefault

Optional. Usage depends on the scope:

  • With Project and Job scopes this parameter is disregarded. The system perfectly knows the source language of each segment.

With other resources, you may want to override a default selection:

  • With DocumentSet scope, the system uses this locale if specified or otherwise chooses the first source language configured in the resource.


string?, Optional
trgsOptional list of target locales for which to calculate edits. If not specified then edits are calculated for ALL locales of the scope. string[]?, Optional


RESULTS

Await creation of text edits report

...

Code Block
{
    "trm": {
		"requestid": 559,
        "status": "Finished",
		...
    },
    "custom": {
        "filetoken": "026171df25c641d0b04316a28cf3cca1"
    }
}

...


When the operation has terminated, download the JSON report with the filetoken and this API method:
 Code Block
(GET) /api/media/get/{filetoken}

Report content
The JSON has these properties:report is a JSON document, see: Text edits report

EXAMPLES
Submit request
We submit this request:
...