Page Comparison

scope

The scope object. The sample will be taken from the segments within this scope (project, job, resource...).

Use these methods to find or enumerate: resources, jobs and projects. You will need the respective IDs to create your scope.

Optionally specify the segments' fields to include in the results. This is done using a layout JSON object.

If not specified, the system will include the most relevant properties (including revision history). This should be just fine in almost all cases:

• Segment level properties such as all IDs, custom fields and labels
• Source language text, flags, custom fields and labels
• Source text related comments
• Target language text, flags, custom fields and labels
• Target text related comments
• Target text revisions.

The target locale (language code).

The expected sample size. Default is 10.

This must be a value between 1 and 50.

Optional boolean. Default is false.

Only set to true if required. If true, then the results are temporarily saved and assigned a token (see sampletoken in results).
You need this token when using the QA workflow API methods in order to create a workflow/jobs for the sample.

Optional boolean. Default is true. If true then the returned JSON includes the result node. Otherwise only the summary statistics are returned.

If you further process results using the sampletoken you may not need the results with this call.