Get capability statistics for analysis set fields

get

https://{subdomain}.alisqi.com/api/getSpecificationEvaluation

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

setId

integer

required

The unique id of the analysis set. Selection lists have no specifications.

This parameter is required and has no default.

Note: 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.

fields

string

required

Comma-separated list of field names, at most 25.

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

indexFieldOptions

string

Only applies to sets with an index field.

Comma-separated list of the index field options to evaluate, at most 25. Specify either only option ids (e.g. 12,15) or only option values (e.g. Product A,Product B).

Defaults to all active options. If this parameter is left out and more than 25 index field options have results, the API returns 400 Bad Request. In that case, specify indexFieldOptions, or narrow down the results with filter.

The response is keyed by the options in the form they are specified here (ids or values).

If an option does not exist, the API returns 500 Internal Server Error with the error Invalid index field option: <option> (not 400 Bad Request). Mixing ids and values is treated as values, so ids then also result in this error.

Don't use this parameter for sets without an index field: it results in 500 Internal Server Error with the error Internal error.

limit

integer

≤ 10000

Defaults to 10000

The maximum number of results to consider while calculating the statistics, per index field option (or in total, for sets without an index field). At most 10,000.

Defaults to 10,000.

filter

string

JSON object as a string.

Specify a filter for the results.

Defaults to none.

Example: {"status_":[{"value":"5"}]}

Note: this parameter is usually called constraints in AlisQI URLs. The API uses filter for consistency with the terminology used in the user interface.
Tip: Use the filter widget in the in-app Integration hub to create a JSON filter string.

Responses

`indexFieldOptions` (ids or values); without `indexFieldOptions`, they are option values.

For sets without an index field, it is keyed by field name.

Index field options without results are left out. If there are no results at all, an empty array (`[]`) is returned.

The statistics of each field are:

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

400Bad Request: a parameter is missing or invalid.

401Unauthorized: no token was provided, or the token is invalid.

403Forbidden: the user associated with the token lacks the required permission, or the request comes from an IP address that is not in the token's IP allow-list.

500Internal Server Error: an unexpected error occurred, the rate limit has been exceeded, or indexFieldOptions is invalid.

`indexFieldOptions` is invalid.