Metrics, Statistics, and Costs
In the SOAP API, you can use these methods related to metrics, statistics and costs:
You can check the Status of projects and jobs:
obtainProjectMetrics()
Obtains original and up-to-date metrics for all jobs and general metrics for the whole project for each target language or one specific target language. This method requires a project descriptor and an optional target language in the additional method options.
obtainJobMetrics()
Obtains original and up-to-date metrics for the specified jobs. This method requires a list of job descriptors.
downloadProjectMetricsURL()
Downloads the
XLSmetrics file. This method requires a project descriptor and returns the URL to the metrics zip file.downloadProjectMetricsMTOM()
Downloads the
XLSmetrics file. This method requires a project descriptor and returns the files as MTOM or BASE64, depending on the chosen web service. Files are packed as azipfile.obtainProjectStatistics()
Obtains up-to-date user statistics for all jobs for the whole project for each target language or one specific target language. This method requires a project descriptor and, optionally, a target language in the additional method options.
obtainProjectAllStatistics()
Obtains up-to-date statistics aggregated on the following levels: project, languages, and users. This method requires a project descriptor and, optionally, a list of target languages in the additional method options.
generateCost()
Creates a cost with a given calculation source type (
CostCalculationSource) for the specified project.CostCalculationSourcevalues used for cost calculation:INITIAL_METRICS – metrics calculated during project analysis.
CURRENT_METRICS – current project metrics.
STATISTICS_SOURCE – statistics based on the source text.
STATISTICS_TARGET – statistics based on the target text.
When time tracking is enabled,
CostCalculationSourceincludes more options:TIME_OR_METRICS_INITIAL – time entered or metrics calculated during project analysis.
TIME_OR_METRICS_CURRENT – time entered for or current project metrics.
TIME_OR_STATISTICS_SOURCE – time entered or statistics based on the source text.
TIME_OR_STATISTICS_TARGET – time entered or statistics based on the source text.
Tracked time or time entered manually is used for the calculation only for workflow steps where a time record exists. The cost of other workflow steps is calculated using initial metrics, current metrics, or source or target statistics.
Additional options:
missingRatesProvider (
XTMCostsMissingRatesEnum) – inserts a zero value for Linguists who do not have a correctly configured rate card.missingTimeProvider (
XTMCostsMissingTimeEnum) – inserts a zero value when the time spent has not been entered.assignment (
XTMCostAssignmentAPI) – calculates a project cost based on a dummy user without changing workflow assignments. This feature can be used for all bundles or bundles without assignments (XTMCostsOverrideAssignmentEnum).
This method returns cost descriptors, which should be used in the method described in point 8.
obtainCost()
Obtains cost for specific cost descriptor (
XTMCostDescriptorAPI). If the ID in the base cost descriptor is set, then this method returns the cost with the given ID. Otherwise, if the project descriptor and calculation source are set, then this method returns the latest cost for these parameters. Otherwise, if only the project descriptor is set, then this method returns the latest cost for the project.obtainProjectEstimates()
Obtains estimates for the specified project. This method requires the project descriptor and returns the price, tax, and delivery date. Requested estimates can be configured using the
XTMEstimatesUpdateAPIobject, which includes the workflow, delivery type, delivery service, number of copies, number of pages, buyer's country, and buyer's EU citizenship parameters. The buyer's country and the buyer's EU citizenship parameters are used to determine whether VAT has to be paid. VAT will be included in the estimates when the seller or the buyer resides outside of the EU or when both of them reside in the same EU country.generateProjectsSimilarity()
Calculates the number of repetitions between two projects. This method requires a list of project pairs to compare and returns the similarity descriptors, which should be used in the method described in point 11.
obtainProjectsSimilarity()
Obtains the number of repetitions between two projects. This method requires a list of similarity descriptors and returns the
XTMProjectsSimilarityMetricsAPIobject for each similarity descriptor.XTMProjectsSimilarityMetricsAPIcontains the number of repetitions between the projects, and additionally, for the second project, the number of exact matches, leverage matches, and the total number of words.updateProjectEstimates()
This method can be used to update the current estimate for the specified project. It requires the project descriptor and the estimate configuration provided in the
XTMEstimatesUpdateAPIobject (described in point 9).
XTMCostsMissingRatesEnum – possible options when Linguists do not have rate cards:
Option | Description |
|---|---|
| Generate zero costs. |
XTMCostsMissingTimeEnum – possible options when the time spent has not been entered:
Option | Description |
|---|---|
| Generate zero costs. |
XTMCostsOverrideAssignmentEnum – possible options for using a dummy user in the generateCost() method:
Option | Description |
|---|---|
| The dummy user will be used in bundles with missing assignments. |
| The dummy user will be used in all bundles. |