API Reference

Use this API operation to get descriptive statistics for numeric analysis set fields of your choice.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required

The unique id of the analysis set.

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.

string
required

Comma separated list of field names.

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

integer

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

Defaults to 50000.

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

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 min represents the minimum value of the field

The max represents the maximum value of the field

The sum represents the sum of all the values of the field

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

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*