Get descriptive statistics for analysis set fields

get

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

setId

integer

required

The unique id of the analysis set or selection list.

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.

Include the pseudo-field @id (or id) to also get the number of results and the lowest and highest result id, in the @id property of the response.

limit

integer

1 to 50000

Defaults to 50000

The maximum number of results to consider while calculating the statistics. Must be between 1 and 50,000.

Defaults to 50,000.

If the set has a date field, the most recent results are used.

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

`@id` was requested, the `@id` property contains the number of results and the lowest and highest result id.

`X-RateLimit-Retry-After`.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A JSON object with one property per requested field, keyed by field name. Each property is an object with the statistics of that field. If the pseudo-field @id was requested, the @id property contains the number of results and the lowest and highest result id.

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.

429Too Many Requests: the rate limit has been exceeded. Retry after the time in X-RateLimit-Retry-After.

500Internal Server Error: an unexpected error occurred.

`@id` was requested, the `@id` property contains the number of results and the lowest and highest result id.

`X-RateLimit-Retry-After`.