# Stats

To perform a stats query on the order resource send a `POST` request to the `/orders/stats` endpoint specifying in the payload the [query keys](#query-keys) and [filter](/metrics-api-reference/resources/orders/filters.md) parameters like in the generic example below:

```json
{
  "stats": {
    "field": "...",
    "operator": "..."
  },
  "filter": { ... }
}
```

{% hint style="info" %}
Please find more information on how stats queries work [here](/metrics/getting-started/queries/stats.md).
{% endhint %}

### Query keys

These are the keys you need to set when performing a stats query:

<table><thead><tr><th>Key</th><th>Type</th><th data-type="checkbox">Required</th><th>Description</th><th>Values</th></tr></thead><tbody><tr><td><strong><code>field</code></strong></td><td>String</td><td>true</td><td>The field you want the metrics or statistics computed on.</td><td>See the <a href="#operators-and-field-values">table below</a> to check the full list of valid values for this key.</td></tr><tr><td><strong><code>operator</code></strong></td><td>String</td><td>false</td><td>The computing operator.</td><td>See the <a href="/pages/FDxerOlRUkZ831rBgsOe#operators-and-field-values">table below</a> to check the full list of valid operators based on the value you assigned to the <code>field</code> key. Default is <code>sum</code>.</td></tr></tbody></table>

### Operators and `field` values

These are the valid values you can specify for the `field` key of the stats query and the related valid operators, based on that key:

| Value                                              | Operators                                                                                                                     |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| **`customer.id`**                                  | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`customer.email`**                               | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`customer.group_name`**                          | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`customer.reference`**                           | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`customer.reference_origin`**                    | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`line_items.code`**                              | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`line_items.discount`**                          | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`line_items.id`**                                | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`line_items.item_id`**                           | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`line_items.options_amount`**                    | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`line_items.quantity`**                          | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`line_items.tax_amount`**                        | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`line_items.tax_rate`**                          | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`line_items.total_amount`**                      | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`line_items.unit_amount`**                       | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`line_items.options.id`**                        | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`line_items.options.quantity`**                  | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`line_items.options.total_amount`**              | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`line_items.options.unit_amount`**               | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`market.id`**                                    | `cardinality`                                                                                                                 |
| **`market.number`**                                | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`order.adjustment_amount`**                      | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.adjustment_tax_amount`**                  | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.adjustment_taxable_amount`**              | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.discount_amount`**                        | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.duty_amount`**                            | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.gift_card_code`**                         | `value_count`                                                                                                                 |
| **`order.gift_card_amount`**                       | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.id`**                                     | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`order.line_item_options_count`**                | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.number`**                                 | `value_count`                                                                                                                 |
| **`order.payment_method_amount`**                  | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.payment_method_tax_amount`**              | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.payment_method_taxable_amount`**          | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.reference`**                              | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`order.reference_origin`**                       | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`order.shipments_count`**                        | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.shipping_amount`**                        | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.shipping_taxable_amount`**                | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.skus_count`**                             | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.subtotal_amount`**                        | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.subtotal_tax_amount`**                    | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.subtotal_taxable_amount`**                | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.total_amount`**                           | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.total_amount_with_taxes`**                | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.total_tax_amount`**                       | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.total_taxable_amount`**                   | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.seconds_in_draft`**                       | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>stats</code></p><p><code>percentiles</code></p> |
| **`order.seconds_in_approved`**                    | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>stats</code></p><p><code>percentiles</code></p> |
| **`order.seconds_in_placed`**                      | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>stats</code></p><p><code>percentiles</code></p> |
| **`order.refunds_total_amount_with_taxes`**        | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`order.total_amount_with_taxes_net_of_refunds`** | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`refunds.id`**                                   | `value_count`                                                                                                                 |
| **`refunds.amount`**                               | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>sum</code></p><p><code>stats</code></p>         |
| **`refunds.number`**                               | `value_count`                                                                                                                 |
| **`shipments.id`**                                 | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.number`**                             | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.items_count`**                        | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>stats</code></p><p><code>percentiles</code></p> |
| **`shipments.cost_amount`**                        | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>stats</code></p><p><code>percentiles</code></p> |
| **`shipments.reference`**                          | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.reference_origin`**                   | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.seconds_in_picking`**                 | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>stats</code></p><p><code>percentiles</code></p> |
| **`shipments.seconds_in_ready_to_ship`**           | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>stats</code></p><p><code>percentiles</code></p> |
| **`shipments.seconds_in_shipped`**                 | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>stats</code></p><p><code>percentiles</code></p> |
| **`shipments.fulfillment_time`**                   | <p><code>avg</code></p><p><code>max</code></p><p><code>min</code></p><p><code>stats</code></p><p><code>percentiles</code></p> |
| **`shipments.stock_location.id`**                  | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.stock_location.reference`**           | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.stock_location.reference_origin`**    | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.shipping_method.id`**                 | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.shipping_method.reference`**          | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.shipping_method.reference_origin`**   | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.shipping_category.id`**               | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.shipping_category.reference`**        | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`shipments.shipping_category.reference_origin`** | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`resource_errors.code`**                         | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`resource_errors.id`**                           | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |
| **`resource_errors.message`**                      | <p><code>cardinality</code></p><p><code>value\_count</code></p>                                                               |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.commercelayer.io/metrics-api-reference/resources/orders/stats.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.