Page Comparison

comments

An array of all comments of the segment, sorted by descending date.

It includes comments in all the scope languages to which the user has access.

See Comment (Object) for details.

An array of all text and flag changes of the segment, sorted by descending date.

These are notably changes of the texts by different workers over time.

See Segment Change (Object) for details.

An object containing the persons referred to by comments or revisions. Note:

• Excludes persons contained in parameter knownpersons.
• Excludes persons that the user cannot see. There is an access right to prevent a user from viewing user and company names.

The object has keys where the key is the person id.

"persons": {
    "_7": {
      "id": 7,
      "nm": "Stephan",
      "cid": 1,
      "cnm": "Tradubee"
    },
    "_3": {
      "id": 3,
      "nm": "Thierry",
      "cid": 1,
      "cnm": "Freelancebee"
    }

• nm: Full name of person
• id: Id of person
• cnm: Company of person
• cid: Company id

A list of all locales available for this segment and which are within the scope. You can use these in a comments/revisions language filter.

A few access rights that are specifically useful when working with the results:

• canSendEmail: When a user adds/edits a comment, this boolean tells if the user can notify the comment by email or not.
• canAdd: Tells if the user can add a new comment in one of the locales.

Note: When using the APIs to add/edit/delete comments, you may obtain a not authorized information even when the edit, canAdd or canSendEmail properties are true. The reason for this is that further detailed access rights check are done upon those advanced operations.

strings

Object that contains names of companies, persons and task codes that are referenced by this report. We include this purely for convenience so that you do not need to issue more calls to get the names. Properties:

• companies: Array of object each with company id ("id") and name ("name")
• persons: Array of object each with company id ("id") and name ("name")
• tasks: Array of object each with task code ("id") and name ("name")

Contains work volume information with totals and individually for each type of job and month:

• totals: An object with grand totals:
  • task: Always null
  • jobs: Total jobs
  • documents: Total documents in jobs
  • segments: Total segments in jobs
  • words: Total words
  • chars: Total characters
  • wdpreident: Total identically pretranslated words
  • wdprefuzzy: Total fuzzy pretranslated words
  • wdfuzzy: Total fuzzy matches or repetitions

• tasks: An array that shows the above information individually per job task type. For example if the supplier translated and revised, you will see totals for translation jobs and totals for revision jobs.

• months: Shows totals per each month in the selected date range. Each array element has these properties:
  • title: The year and month as a string
  • jobs: Total jobs in month
  • words: Total words in month
  • chars: Total chars in month

How monthly volume can be rendered:

Image Added

Provides information on the total changes done in segments.

Example: If user A edits a segment, which is then edited by B and again edited by A. We count 3 actions for supplier: 1 translation action, 1 corrected, 1 revision. We count 2 actions for A: 1 revision, 1 corrected.

• cnt: Total jobs with at least one action
• total: Total actions
• translation: Total translation actions i.e. editing previously empty segments
• revision: Total editing actions i.e. editing of previously human translated segments
• postediting: Total post-editing actions i.e. editing of previously not human translated segments
• corrected: Total segments edited by the supplier and which were subsequently edited by someone else
• segments: Total number of segments concerned by the actions (one segment can have more than one action)

Provides histograms for detailed analysis of supplier response times (time from reception of job to acceptance of job), respect of deadlines:

Histograms are stored in these properties:

• responseTime: Histogram for time from start to completion of jobs.
• deadlineTime: Histogram for time difference between job completion and deadline.
• assignedTime: Histogram for time from assignment to acceptance/start of jobs.
• dailyVolumeAssigned: Histogram for time from start to completion of jobs.
• dailyVolumeWorked: Histogram for time from start to completion of jobs.
• dailyVolumeActual: Histogram for time from start to completion of jobs.

In addition you find:

• responseTimeNone: Total jobs without any response time. Not included in histograms.
• deadlineTimeNone: Total jobs without deadline. Not included in histograms.

Each histogram is an object with these properties:

• cnt: Total jobs added to the histogram
• sum: Sum of all values calculated for all jobs. Depending on the histogram the value can be a time difference, the number of words, etc.
• nocnt: Total jobs not added in histogram. The reason is that the value to add was not available for the job.
• slots: The slots of the histogram. An array of objects:
  • label: Title of slot
  • min: Slot minimum value (x-axis)
  • max: Slot maximum value (x-axis)
  • cnt: Total jobs counted in slot (y-axis). Total jobs for which the calculate value in slot's min/max range
  • pdf: Cumulative count from first slot up to this slot

Example histogram:

Image Added

If the BA report is generated for "My company" you will find the list of all inhouse workers. Each array element has these properties:

• id: If 0 then the record is for jobs not assigned to a specific worker or assigned to a now deleted worker. Otherwise the id of the worker.
• jobs: Jobs assigned to worker
• documents
• words
• chars
• jobsintime: Total jobs delivered in time
• acnt: Total jobs with actions. If different from "jobs", then the worker did not do any changes in some jobs.
• atot: Total actions.
• acr: Total corrected actions.

List of all project managers involved with the jobs. Same structure as workers above.

Volume per language couple. An array with objects:

• id: Language couple key
• st: Source locale
• tt: Target locale
• jobs: Total jobs
• words: Total words
• chars: Total chars

Information on other companies or workers with which the present supplier was involved in workflows. An array with objects:

• cid: Other company
• pid: Other worker. 0 if not specific person.
• task1: Task type of this supplier
• task2: Task type of suppier cid/pid
• jobs: Total jobs
• words: Total words
• chars: Total chars

Image Added

Ratings given to the jobs of the supplier, either by the supplier himself or his manager.

A rating is a value between 1 (worst) and 5 (best). There are zero, one or more categories that can be rated. The categories are configured in the Wordbee Translator platform.

• manager: An object with ratings given by manager
• supplier: An object with ratings given by supplier him/herself

Each of these two objects has these properties:

• rated: Total jobs rated
• unrated: Total jobs not rated
• all: A histogram that gives the total ratings (all categories combined) per rating values 1, 2, 3, 4, 5
• q: An array with the histograms per each rating category.

Each histogram has these properties:

• q: Rating ategory id.
• qtitle: Title of rating category.
• cnt: Total ratings.
• avg: Average rating value
• std: Standard deviation.
• s: An integer array with one element per rating value (1, 2... 6). Each element is the total jobs rated.

Example:

   "worker": {
      "rated": 0,
      "unrated": 6,
      "all": {
        "q": -1,
        "qtitle": "All ratings",
        "cnt": 4,
        "avg": 4,
        "std": 2,
        "s": [
          0,
          

...

This is how a histogram could be rendered (no ratings done here):

Image Added