v1

latestOpenAPI 3.0.32026-07-14101033.6 KB
Statistics

Get capability statistics for analysis set fields

Use this API operation to get in-depth statistics of specification evaluation and product and process capability for an analysis set's numeric fields.

get/getSpecificationEvaluation

Query parameters

setIdinteger required

The unique id of the analysis set.

This parameter is required and has no default.

<b>Note</b>: for historical reasons, this parameter is usually called maskid in AlisQI URLs. The API uses setId for consistency with the terminology used in the user interface.

fieldsstring required

Comma seperated list of field names.

Use the in-app integration hub to find the field names for a particular analysis set.

limitinteger

The maximum number of results to consider while calculating the statistics.

Defaults to 50000.

filterstring

JSON object as a string.

Specify a filter for the results.

Defaults to none.

<b>Example</b>: {"status_":[{"value":"5"}]}<br><br> <b>Note</b>: this parameter is usually called constraints in AlisQI URLs. The API uses filter for consistency with the terminology used in the user interface.<br><b>Tip</b>: Use the filter widget in the in-app Integration hub to create a JSON filter string.

Response

The output will be a JSON-encoded array. Each array element contains the following JSON object:

The count represents the number of values

The no-spec represents the number of values without spec

The in-spec represents the number of values within spec bandwidth

The offspec-internal represents the number of values off-spec in the internal spec range

The offspec-external represents the number of values off-spec in the external spec range

The avg represents the average of all the values of the field

The stddev represents the standard deviation of all the values of the field

The cp represents the Cp value

The cpk represents the Cpk value

The pp represents the Pp value

The ppk represents the Ppk value

The lcl represents the Computed value: Average - 3x standard deviation

The ucl represents the Computed value: Average + 3x standard deviation

object[] required
OR
SpecificationsEvaluation required