Fluent Commerce Logo
Docs

fc.analytics.queries.orders

Setting

Changed on:

24 Nov 2025

Setting AreaUI component
Supported context levels:ACCOUNT, RETAILER

Overview

The `fc.analytics.queries.orders` is a configuration that defines the analytics queries for the Fluent Analytics order dashboard

Values

Data TypeValues
JSON
1{
2  "queries": [
3    {
4      "name": "total_revenue",
5      "resource": {
6        "type": "PATH",
7        "value": "Standard Template/Dashboards/Orders/Total Revenue"
8      },
9      "roles": [
10        "ORDER_MANAGER"
11      ]
12    },
13    {
14      "name": "cancellation_rate",
15      "resource": {
16        "type": "PATH",
17        "value": "Standard Template/Dashboards/Orders/Order Cancellation Rate"
18      },
19      "roles": [
20        "ORDER_MANAGER"
21      ]
22    },
23    {
24      "name": "total_orders",
25      "resource": {
26        "type": "PATH",
27        "value": "Standard Template/Dashboards/Orders/Total Orders"
28      },
29      "roles": [
30        "ORDER_MANAGER"
31      ]
32    },
33    {
34      "name": "by_order_type",
35      "resource": {
36        "type": "PATH",
37        "value": "Standard Template/Dashboards/Orders/Orders by Order Type"
38      },
39      "roles": [
40        "ORDER_MANAGER"
41      ]
42    },
43    {
44      "name": "average_order_value",
45      "resource": {
46        "type": "PATH",
47        "value": "Standard Template/Dashboards/Orders/Average Order Value"
48      },
49      "roles": [
50        "ORDER_MANAGER"
51      ]
52    },
53    {
54      "name": "average_order_items",
55      "resource": {
56        "type": "PATH",
57        "value": "Standard Template/Dashboards/Orders/Average Order Items"
58      },
59      "roles": [
60        "ORDER_MANAGER"
61      ]
62    },
63    {
64      "name": "average_orders_by_hour_of_day",
65      "resource": {
66        "type": "PATH",
67        "value": "Standard Template/Dashboards/Orders/Average Orders by Hour of Day"
68      },
69      "roles": [
70        "ORDER_MANAGER"
71      ]
72    }
73  ]
74}
75

Detailed technical description

The queries configured in this setting serve as an example aligned with the Fluent Analytics reference order dashboard. You can customize these values to match the relevant to your setup.

Configuration example

1POST {{fluentApiHost}}/graphql
2
3mutation CreateSetting {
4   createSetting(input: {
5		name: "fc.analytics.queries.orders", 
6		valueType: "JSON", 
7		lobValue: $lobValue , 
8		context: "ACCOUNT", 
9		contextId: 0}) {
10    id
11    name
12  }
13}
14		
15GraphQL variables:
16{
17    "lobValue" : [
18      {
19        "queries": [
20          {
21            "name": "total_revenue",
22            "resource": {
23              "type": "PATH",
24              "value": "Standard Template/Dashboards/Orders/Total Revenue"
25            },
26            "roles": [
27              "ORDER_MANAGER"
28            ]
29          },
30          {
31            "name": "cancellation_rate",
32            "resource": {
33              "type": "PATH",
34              "value": "Standard Template/Dashboards/Orders/Order Cancellation Rate"
35            },
36            "roles": [
37              "ORDER_MANAGER"
38            ]
39          },
40          {
41            "name": "total_orders",
42            "resource": {
43              "type": "PATH",
44              "value": "Standard Template/Dashboards/Orders/Total Orders"
45            },
46            "roles": [
47              "ORDER_MANAGER"
48            ]
49          },
50          {
51            "name": "by_order_type",
52            "resource": {
53              "type": "PATH",
54              "value": "Standard Template/Dashboards/Orders/Orders by Order Type"
55            },
56            "roles": [
57              "ORDER_MANAGER"
58            ]
59          },
60          {
61            "name": "average_order_value",
62            "resource": {
63              "type": "PATH",
64              "value": "Standard Template/Dashboards/Orders/Average Order Value"
65            },
66            "roles": [
67              "ORDER_MANAGER"
68            ]
69          },
70          {
71            "name": "average_order_items",
72            "resource": {
73              "type": "PATH",
74              "value": "Standard Template/Dashboards/Orders/Average Order Items"
75            },
76            "roles": [
77              "ORDER_MANAGER"
78            ]
79          },
80          {
81            "name": "average_orders_by_hour_of_day",
82            "resource": {
83              "type": "PATH",
84              "value": "Standard Template/Dashboards/Orders/Average Orders by Hour of Day"
85            },
86            "roles": [
87              "ORDER_MANAGER"
88            ]
89          }
90        ]
91      }
92    ]
93}
94