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 4 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:

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

Also see example at the end of this page.

 

object
actions  
histo  
workers  
managers  
clients  
languages  
team  
ratings  

 

EXAMPLE

Sample results for an external supplier company:

 

{
  "strings": {
    "companies": [
      {
        "id": 2,
        "name": "Wordbee S.A."
      },
      {
        "id": 210,
        "name": "Quoc ltd"
      },
      {
        "id": 276,
        "name": "Quoc Freelancer"
      }
    ],
    "persons": [
      {
        "id": 88,
        "name": "NGUYEN DANG Huy Quoc"
      },
      {
        "id": 368,
        "name": "N Quoc Freelancer"
      }
    ],
    "tasks": [
      {
        "id": "TR",
        "name": "Translation"
      },
      {
        "id": "RV",
        "name": "Revision"
      }
    ]
  },
  "volume": {
    "totals": {
      "task": null,
      "jobs": 6,
      "documents": 8,
      "segments": 2633,
      "words": 18874,
      "chars": 104352,
      "wdpreident": 67,
      "wdprefuzzy": 79,
      "wdfuzzy": 2652
    },
    "tasks": [
      {
        "task": "TR",
        "jobs": 2,
        "documents": 3,
        "segments": 110,
        "words": 1018,
        "chars": 5128,
        "wdpreident": 0,
        "wdprefuzzy": 0,
        "wdfuzzy": 36
      },
      {
        "task": "RV",
        "jobs": 4,
        "documents": 5,
        "segments": 2523,
        "words": 17856,
        "chars": 99224,
        "wdpreident": 67,
        "wdprefuzzy": 79,
        "wdfuzzy": 2616
      }
    ],
    "months": [
      {
        "title": "2017 - 5",
        "jobs": 1,
        "words": 80,
        "chars": 413
      },
      {
        "title": "2017 - 6",
        "jobs": 5,
        "words": 18794,
        "chars": 103939
      },
      {
        "title": "2017 - 7",
        "jobs": 0,
        "words": 0,
        "chars": 0
      }
    ]
  },
  "actions": {
    "cnt": 6,
    "total": 12,
    "translation": 12,
    "revision": 0,
    "postediting": 0,
    "corrected": 0,
    "segments": 2633
  },
  "histo": {
    "responseTimeNone": 0,
    "deadlineTimeNone": 4,
    "responseTime": {
      "cnt": 6,
      "sum": 40,
      "nocnt": 0,
      "slots": [
        {
          "label": "30 minutes",
          "min": 0,
          "max": 30,
          "cnt": 6,
          "pdf": 6
        },
        {
          "label": "1 hour",
          "min": 31,
          "max": 60,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "2 hours",
          "min": 61,
          "max": 120,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "3 hours",
          "min": 121,
          "max": 180,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "4 hours",
          "min": 181,
          "max": 240,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "8 hours",
          "min": 241,
          "max": 480,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "12 hours",
          "min": 481,
          "max": 720,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "16 hours",
          "min": 721,
          "max": 960,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "20 hours",
          "min": 961,
          "max": 1200,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "24 hours",
          "min": 1201,
          "max": 1440,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "36 hours",
          "min": 1441,
          "max": 2160,
          "cnt": 0,
          "pdf": 6
        },
        {
          "label": "2 days or more",
          "min": 2161,
          "max": 2147483647,
          "cnt": 0,
          "pdf": 6
        }
      ],
      "within1h": 6,
      "within8h": 6,
      "within24h": 6
    },
    "deadlineTime": {
      "cnt": 2,
      "sum": -11365,
      "nocnt": 4,
      "slots": [
        {
          "label": "2 days early",
          "min": -2147483648,
          "max": -2161,
          "cnt": 1,
          "pdf": 1
        },
        {
          "label": "36 hours early",
          "min": -2160,
          "max": -1441,
          "cnt": 1,
          "pdf": 2
        },
        {
          "label": "24 hours early",
          "min": -1440,
          "max": -961,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "16 hours early",
          "min": -960,
          "max": -481,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "8 hours early",
          "min": -480,
          "max": -241,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "4 hours early",
          "min": -240,
          "max": -181,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "3 hours early",
          "min": -180,
          "max": -121,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "2 hours early",
          "min": -120,
          "max": -61,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "1 hour early",
          "min": -60,
          "max": 0,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "1 hour late",
          "min": 1,
          "max": 60,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "2 hours late",
          "min": 61,
          "max": 120,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "3 hours late",
          "min": 121,
          "max": 180,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "4 hours late",
          "min": 181,
          "max": 240,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "8 hours late",
          "min": 241,
          "max": 480,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "16 hours late",
          "min": 481,
          "max": 960,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "24 hours late",
          "min": 961,
          "max": 1440,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "36 hours late",
          "min": 1441,
          "max": 2160,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "2 days late",
          "min": 2161,
          "max": 2147483647,
          "cnt": 0,
          "pdf": 2
        }
      ],
      "after": 0,
      "before": 6,
      "late8h": 0,
      "late24h": 0
    },
    "assignedTime": {
      "cnt": 2,
      "sum": 11378,
      "nocnt": 4,
      "slots": [
        {
          "label": "Less than 1 day",
          "min": 0,
          "max": 1439,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "1 day",
          "min": 1440,
          "max": 2879,
          "cnt": 1,
          "pdf": 1
        },
        {
          "label": "2 days",
          "min": 2880,
          "max": 4319,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "3 days",
          "min": 4320,
          "max": 5759,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "4 days",
          "min": 5760,
          "max": 7199,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "5 days",
          "min": 7200,
          "max": 8639,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "6 days",
          "min": 8640,
          "max": 10079,
          "cnt": 1,
          "pdf": 2
        },
        {
          "label": "7 days",
          "min": 10080,
          "max": 11519,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "8 days",
          "min": 11520,
          "max": 12959,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "9 days",
          "min": 12960,
          "max": 14399,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "10 days",
          "min": 14400,
          "max": 15839,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "11 days",
          "min": 15840,
          "max": 17279,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "12 days",
          "min": 17280,
          "max": 18719,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "13 days",
          "min": 18720,
          "max": 20159,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "14 days",
          "min": 20160,
          "max": 21599,
          "cnt": 0,
          "pdf": 2
        },
        {
          "label": "15 days or more",
          "min": 21600,
          "max": 2147483647,
          "cnt": 0,
          "pdf": 2
        }
      ],
      "less1day": 0,
      "upto5days": 1,
      "upto10days": 2,
      "equalmore5days": 1,
      "equalmore10days": 0
    },
    "dailyVolumeAssigned": {
      "cnt": 1,
      "sum": 734,
      "nocnt": 0,
      "slots": [
        {
          "label": "0 to 500",
          "min": 0,
          "max": 499,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "500 to 1000",
          "min": 500,
          "max": 999,
          "cnt": 1,
          "pdf": 1
        },
        {
          "label": "1000 to 1500",
          "min": 1000,
          "max": 1499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "1500 to 2000",
          "min": 1500,
          "max": 1999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "2000 to 2500",
          "min": 2000,
          "max": 2499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "2500 to 3000",
          "min": 2500,
          "max": 2999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "3000 to 3500",
          "min": 3000,
          "max": 3499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "3500 to 4000",
          "min": 3500,
          "max": 3999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "4000 to 4500",
          "min": 4000,
          "max": 4499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "4500 to 5000",
          "min": 4500,
          "max": 4999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "5000 to 5500",
          "min": 5000,
          "max": 5499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "5500 to 6000",
          "min": 5500,
          "max": 5999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "6000 and more",
          "min": 6000,
          "max": 2147483647,
          "cnt": 0,
          "pdf": 1
        }
      ]
    },
    "dailyVolumeWorked": {
      "cnt": 1,
      "sum": 2814,
      "nocnt": 0,
      "slots": [
        {
          "label": "0 to 500",
          "min": 0,
          "max": 499,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "500 to 1000",
          "min": 500,
          "max": 999,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "1000 to 1500",
          "min": 1000,
          "max": 1499,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "1500 to 2000",
          "min": 1500,
          "max": 1999,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "2000 to 2500",
          "min": 2000,
          "max": 2499,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "2500 to 3000",
          "min": 2500,
          "max": 2999,
          "cnt": 1,
          "pdf": 1
        },
        {
          "label": "3000 to 3500",
          "min": 3000,
          "max": 3499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "3500 to 4000",
          "min": 3500,
          "max": 3999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "4000 to 4500",
          "min": 4000,
          "max": 4499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "4500 to 5000",
          "min": 4500,
          "max": 4999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "5000 to 5500",
          "min": 5000,
          "max": 5499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "5500 to 6000",
          "min": 5500,
          "max": 5999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "6000 and more",
          "min": 6000,
          "max": 2147483647,
          "cnt": 0,
          "pdf": 1
        }
      ]
    },
    "dailyVolumeActual": {
      "cnt": 1,
      "sum": 2814,
      "nocnt": 0,
      "slots": [
        {
          "label": "0 to 500",
          "min": 0,
          "max": 499,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "500 to 1000",
          "min": 500,
          "max": 999,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "1000 to 1500",
          "min": 1000,
          "max": 1499,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "1500 to 2000",
          "min": 1500,
          "max": 1999,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "2000 to 2500",
          "min": 2000,
          "max": 2499,
          "cnt": 0,
          "pdf": 0
        },
        {
          "label": "2500 to 3000",
          "min": 2500,
          "max": 2999,
          "cnt": 1,
          "pdf": 1
        },
        {
          "label": "3000 to 3500",
          "min": 3000,
          "max": 3499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "3500 to 4000",
          "min": 3500,
          "max": 3999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "4000 to 4500",
          "min": 4000,
          "max": 4499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "4500 to 5000",
          "min": 4500,
          "max": 4999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "5000 to 5500",
          "min": 5000,
          "max": 5499,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "5500 to 6000",
          "min": 5500,
          "max": 5999,
          "cnt": 0,
          "pdf": 1
        },
        {
          "label": "6000 and more",
          "min": 6000,
          "max": 2147483647,
          "cnt": 0,
          "pdf": 1
        }
      ]
    }
  },
  "workers": [
    {
      "id": 0,
      "jobs": 5,
      "documents": 7,
      "words": 18794,
      "chars": 103939,
      "jobsintime": 4,
      "acnt": 1,
      "atot": 12,
      "acr": 0
    },
    {
      "id": 368,
      "jobs": 1,
      "documents": 1,
      "words": 80,
      "chars": 413,
      "jobsintime": 1,
      "acnt": 0,
      "atot": 0,
      "acr": 0
    }
  ],
  "managers": [
    {
      "id": 88,
      "jobs": 4,
      "documents": 5,
      "words": 1479,
      "chars": 7511,
      "jobsintime": 4,
      "acnt": 1,
      "atot": 12,
      "acr": 0
    },
    {
      "id": 2,
      "jobs": 1,
      "documents": 2,
      "words": 17392,
      "chars": 96826,
      "jobsintime": 1,
      "acnt": 0,
      "atot": 0,
      "acr": 0
    },
    {
      "id": 0,
      "jobs": 1,
      "documents": 1,
      "words": 3,
      "chars": 15,
      "jobsintime": 0,
      "acnt": 0,
      "atot": 0,
      "acr": 0
    }
  ],
  "clients": [
    {
      "id": 210,
      "jobs": 5,
      "documents": 7,
      "words": 18871,
      "chars": 104337,
      "jobsintime": 5,
      "acnt": 1,
      "atot": 12,
      "acr": 0
    },
    {
      "id": 2,
      "jobs": 1,
      "documents": 1,
      "words": 3,
      "chars": 15,
      "jobsintime": 0,
      "acnt": 0,
      "atot": 0,
      "acr": 0
    }
  ],
  "languages": [
    {
      "id": "en,fr",
      "st": "English (en)",
      "tt": "French (fr)",
      "jobs": 3,
      "words": 1098,
      "chars": 4715
    },
    {
      "id": "en-US,pt-BR",
      "st": "English (United States) (en-US)",
      "tt": "Portuguese (Brazil) (pt-BR)",
      "jobs": 1,
      "words": 17392,
      "chars": 96826
    },
    {
      "id": "en-GB,zh-HK",
      "st": "English (United Kingdom) (en-GB)",
      "tt": "Chinese (Traditional, Hong Kong S.A.R.) (zh-HK)",
      "jobs": 1,
      "words": 381,
      "chars": 1970
    },
    {
      "id": "fr,en",
      "st": "French (fr)",
      "tt": "English (en)",
      "jobs": 1,
      "words": 3,
      "chars": 15
    }
  ],
  "team": [],
  "ratings": {
    "manager": {
      "rated": 0,
      "unrated": 6,
      "all": {
        "q": -1,
        "qtitle": "All ratings",
        "cnt": 0,
        "avg": 0,
        "std": -1,
        "s": [
          0,
          0,
          0,
          0,
          0
        ]
      },
      "q": [
        {
          "q": 1,
          "qtitle": "Work quality",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 4,
          "qtitle": "Text complexity",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 6,
          "qtitle": "Team quality",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        }
      ]
    },
    "worker": {
      "rated": 0,
      "unrated": 6,
      "all": {
        "q": -1,
        "qtitle": "All ratings",
        "cnt": 0,
        "avg": 0,
        "std": -1,
        "s": [
          0,
          0,
          0,
          0,
          0
        ]
      },
      "q": [
        {
          "q": 0,
          "qtitle": "Overall",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 1,
          "qtitle": "Work quality",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 2,
          "qtitle": "Timeliness",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 3,
          "qtitle": "Reliability",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 4,
          "qtitle": "Text complexity",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 5,
          "qtitle": "Difficulty",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 6,
          "qtitle": "Team quality",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 7,
          "qtitle": "Friendliness",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 8,
          "qtitle": "Challenge",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 9,
          "qtitle": "Pretranslation",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 10,
          "qtitle": "Source text quality",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        },
        {
          "q": 11,
          "qtitle": "Translation quality",
          "cnt": 0,
          "avg": 0,
          "std": -1,
          "s": [
            0,
            0,
            0,
            0,
            0
          ]
        }
      ]
    }
  },
  "getfilter": true
}

 

 

 

 

  • No labels