> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# aggregate_statistics

### aggregate\_statistics

<ul>
  <li>
    aggregate\_statistics(\
    &#x20;table\_name: string,\
    &#x20;column\_name: string,\
    &#x20;stats: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[AggregateStatisticsResponse](https://docs.kinetica.com/content/api/javascript/interfaces/AggregateStatisticsResponse.md)>

    Calculates the requested statistics of the given column(s) in a given table.The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted\_average, cardinality (unique count), estimated\_cardinality, percentile, and percentile\_rank.Estimated cardinality is calculated by using the hyperloglog approximation technique.Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile\_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile\_rank(1234.56),percentile\_rank(-5)').A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.The weighted average statistic requires a weight column to be specified in weight\_column\_name. The weighted average is then defined as the sum of the products of `column_name` times the weight\_column\_name values divided by the sum of the weight\_column\_name values.Additional columns can be used in the calculation of statistics via additional\_column\_names. Values in these columns will be included in the overall aggregate calculation--individual aggregates will not be calculated per additional column. For instance, requesting the count and mean of `column_name` x and additional\_column\_names y and z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, and z values (30), and the single average value across all x, y, and z values (15.5).The response includes a list of key/value pairs of each statistic requested and its corresponding value.

    #### Parameters

    <ul>
      <li>
        table\_name: string

        Name of the table on which the statistics operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
      </li>

      <li>
        column\_name: string

        Name of the primary column for which the statistics are to be calculated.
      </li>

      <li>
        stats: string

        Comma separated list of the statistics to calculate, e.g. "sum,mean".
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AggregateStatisticsResponse](https://docs.kinetica.com/content/api/javascript/interfaces/AggregateStatisticsResponse.md)>

    Promise\<Types.AggregateStatisticsResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:3659](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L3659)</li>
    </ul>
  </li>
</ul>

### aggregate\_statistics\_request

<ul>
  <li>
    aggregate\_statistics\_request(\
    &#x20;request: [AggregateStatisticsRequest](https://docs.kinetica.com/content/api/javascript/interfaces/AggregateStatisticsRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[AggregateStatisticsResponse](https://docs.kinetica.com/content/api/javascript/interfaces/AggregateStatisticsResponse.md)>

    Calculates the requested statistics of the given column(s) in a given table.The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted\_average, cardinality (unique count), estimated\_cardinality, percentile, and percentile\_rank.Estimated cardinality is calculated by using the hyperloglog approximation technique.Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile\_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile\_rank(1234.56),percentile\_rank(-5)').A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.The weighted average statistic requires a weight column to be specified in weight\_column\_name. The weighted average is then defined as the sum of the products of `column_name` times the weight\_column\_name values divided by the sum of the weight\_column\_name values.Additional columns can be used in the calculation of statistics via additional\_column\_names. Values in these columns will be included in the overall aggregate calculation--individual aggregates will not be calculated per additional column. For instance, requesting the count and mean of `column_name` x and additional\_column\_names y and z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, and z values (30), and the single average value across all x, y, and z values (15.5).The response includes a list of key/value pairs of each statistic requested and its corresponding value.

    #### Parameters

    <ul>
      <li>
        request: [AggregateStatisticsRequest](https://docs.kinetica.com/content/api/javascript/interfaces/AggregateStatisticsRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AggregateStatisticsResponse](https://docs.kinetica.com/content/api/javascript/interfaces/AggregateStatisticsResponse.md)>

    Promise\<Types.AggregateStatisticsResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:3596](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L3596)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.