Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

This method returns a business analytics report for a supplier company or person.

The report is calculated from the jobs that were assigned to the supplier and includes:

  • Total job volume and monthly volume
  • Total editing actions (translated or revised segments, post edits etc.)
  • Statistics on response time, delivery in time etc.
  • Clients, managers and other suppliers for or with which the supplier worked (team setups)
  • Ratings and metrics

This information is identical to what you can see in Wordbee Translator:

  • Navigate to a supplier's company page and click the "Statistics" tab
  • Navigate to an inhouse worker's page and click the "Statistics" tab 

Note: For this method to work you need to have a subscription for the Business Analytics component.

URL

(GET) /ba/suppliers/{cid}/{uid}

PARAMETERS

The URL parameters are:

cidCompany for which to return data. This parameter is mandatory. The ID can be the platform company (My Company).int, Mandatory
uid

Optionally restricts data to a specific user within the company.

int?, Optional
   
 Jobs filter (optional): 
taskDelimit statistics to jobs of this specific task type. For example: "TR", "RV"... If not set then data for jobs of any kind are loaded.string?, Optional
slocDelimit to jobs with this source locale.string?, Optional
tlocDelimit to jobs with this target locale.string?, Optional
managerDelimit jobs to projects managed by this user.int?, Optional
clientDelimit jobs to projects where the client company is this ID.int?, Optional
   
 Date range filter (optional): 
fromyearAggregate analytical data starting with this year (2016, 2017....). If not specified then set to the current year.int?, Optional
frommonthAggregate analytical data starting with this month of the year (1, 2...12). If not specified then set to 1.int?, Optional
toyearAggregate analytical data up to and including this year (2016, 2017....). If not specified then same as "fromyear".int?, Optional
tomonthAggregate analytical data up to and including this month of the year (1, 2...12). If not specified then set to 12.int?, Optional
   

 

Examples:

Get data for the current year (January to current month) and company 12344:

/ba/suppliers/12344

Get data for March to April 2017 and person 223 of company 12344:

/ba/suppliers/12344/223?fromyear=2017&frommonth=3&tomonth=12


RESULTS

A JSON with these properties:

Work volume by language couple. An array of objects:

 

 

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")

 

object
volume

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:

object
actions

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)

 

 
histo

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:

 

 

 
workers

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.

 

 
managers

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

 
clientsList of all client companies involved with the jobs. Same structure as workers above. 
languages

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

 

 
team

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

 

 

 

 
ratings  

 

EXAMPLE

Sample results for an external supplier company:

Example - ba/suppliers/{cid}/{uid}

 

 

 

  • No labels