Skip to content

Data Format

The data managed by ChartFactor, whether is the data returned by a query, or the one that is injected directly to a visualization, follows specific formats, which are JSON object structures described in the sections below.

Hierarchy Array Format (HAF)

This format is accepted by out-of-the-box standard visualizations and its structure is shown below.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
var data = [
{
    "group":["Peugeot"],
    "current":{
        "metrics":{
            "Price":8000
        }
    }
},
{
    "group":["Renault"],
    "current":{
        "metrics":{
        "Price": 9000
        }
    }
}
]

The "data" variable is an array. Each item in the array is an object that includes groups and metrics.

Groups

The group attribute is an array of strings.  The number of elements within this array depends on the number of attributes that have been grouped. The previous example includes only one element, so it can be used with visualizations like Bars, Pie, Donut... When we have two values in the group array, we can visualize this data using "Multi-Group visualizations" like Stacked Bars, Grouped Bars, and Heat Map for example.

1
{ group: ["Peugeot", "France"], ... }

The number of elements in the group array must be consistent, so if one data object has 2 elements, the rest should also have 2 elements. If there is no value for some of them, they should be completed with null.

Metrics

Metrics should be specified within the current -> metrics object. There can be as many metrics as you need. Each metric should have an entry within the metrics attribute with the name of the metric and the value for that metric for the current item. There is a difference between data that is obtained in queries, and data that is injected manually to a non-queried visual for the metrics. The previous example represents data injected manually and the following example shows data obtained from a query:  

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
var data = [
{
    "group":["Peugeot"],
    "current":{
        "count": 1,
        "metrics":{
            "Price":{ sum: 1000, avg: 1000}
        }
    }
},
{
    "group":["Renault"],
    "current":{
        "count":4,
        "metrics":{
            "Price":{ sum: 36000, avg: 9000}
        }
    }
}
]

Notice that the differences are in the presence of the "count" attribute, which shows the number of items represented by the group value (1 Peugeot and 4 Renaults). The second difference is that the metric "Price" is not a value but an object, that in this case contains different values depending on the requested function for that metric (sum, avg, min, max).

Field‑Map Object Format (FOF)

This section outlines the structure of the response object returned when performing paginated aggregate queries. A paginated aggregate query occurs when we specify the .limit(n) function to a Top-n/Bottom-n AQL definition.

Note

Pagination of aggregated queries is currently only supported for SQL data providers

There are two related cases:

  • Row-Group Aggregation: The AQL includes group attributes.
  • Row-Group and Column-Group Aggregation: The AQL includes group and column group atributes to obtain an intersection between group and column group values.

Although the format of the response of these cases is consistent, it is helpful to describe them separately.

Row-Group Aggregation

Let's examine the response of the AQL below:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
let group1 = cf.Attribute("company")
    .limit(10)
    .sort("desc", cf.Metric("fare", "sum"));
let group2 = cf.Attribute("pickup_community_area_desc")
    .limit(10)
    .sort("desc", cf.Metric("fare", "sum"));

let metric0 = cf.Metric("fare", "sum");

cf.provider('BigQuery')
    .source('tidal-solstice-206117:Aktiun.chicago_taxi_trips')
    .groupby(group1, group2)
    .metrics(metric0)
    .element('dummy')
    .limit(100)
    .execute()
    .then(function(result){
        console.log(result.data)
    })

The example response is below:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
{
    "data": [
        {
            "company": "NULL",
            "pickup_community_area_desc": "Near North Side",
            "||fare|sum": 11573.68000626564
        },
        {
            "company": "NULL",
            "pickup_community_area_desc": "Loop",
            "||fare|sum": 8008.45000576973
        },
        {
            "company": "Taxi Affiliation Services",
            "pickup_community_area_desc": "Near North Side",
            "||fare|sum": 10777.599995136261
        },
        {
            "company": "Taxi Affiliation Services",
            "pickup_community_area_desc": "Near West Side",
            "||fare|sum": 2873.7000048160553
        },
        {
            "company": "Taxi Affiliation Services",
            "pickup_community_area_desc": "Lake View",
            "||fare|sum": 2285.8500010967255
        },
        {
            "company": "Taxi Affiliation Services",
            "pickup_community_area_desc": "Garfield Ridge",
            "||fare|sum": 2241.7000017166138
        },
        {
            "company": "Taxi Affiliation Services",
            "pickup_community_area_desc": "Lincoln Park",
            "||fare|sum": 1915.25000333786
        },
        {
            "company": "Taxi Affiliation Services",
            "pickup_community_area_desc": "West Town",
            "||fare|sum": 1404.9999992847443
        },
        {
            "company": "Taxi Affiliation Services",
            "pickup_community_area_desc": "Near South Side",
            "||fare|sum": 990.0999932289126
        },
        {
            "company": "Taxi Affiliation Services",
            "pickup_community_area_desc": "Uptown",
            "||fare|sum": 652.2000002861022
        },
        {
            "company": "Dispatch Taxi Affiliation",
            "pickup_community_area_desc": "Near North Side",
            "||fare|sum": 3319.369995612651
        },
        {
            "company": "Dispatch Taxi Affiliation",
            "pickup_community_area_desc": "West Town",
            "||fare|sum": 437.6500015258792
        },
        {
            "company": "Dispatch Taxi Affiliation",
            "pickup_community_area_desc": "Near South Side",
            "||fare|sum": 260.4000005722045
        },
        {
            "company": "Dispatch Taxi Affiliation",
            "pickup_community_area_desc": "Uptown",
            "||fare|sum": 167.44999885559088
        },
        {
            "company": "Dispatch Taxi Affiliation",
            "pickup_community_area_desc": "Logan Square",
            "||fare|sum": 157.95000171661363
        },
        {
            "company": "Blue Ribbon Taxi Association Inc.",
            "pickup_community_area_desc": "Near North Side",
            "||fare|sum": 2302.1500010490417
        },
        {
            "company": "Blue Ribbon Taxi Association Inc.",
            "pickup_community_area_desc": "Loop",
            "||fare|sum": 1844.1999988555906
        },
        {
            "company": "Blue Ribbon Taxi Association Inc.",
            "pickup_community_area_desc": "O'Hare",
            "||fare|sum": 1051.4500017166138
        },
        {
            "company": "Choice Taxi Association",
            "pickup_community_area_desc": "Near North Side",
            "||fare|sum": 2037.1499919891357
        },
        {
            "company": "Choice Taxi Association",
            "pickup_community_area_desc": "O'Hare",
            "||fare|sum": 1630.599995613098
        },
        {
            "company": "Choice Taxi Association",
            "pickup_community_area_desc": "Loop",
            "||fare|sum": 1259.200007915497
        },
        {
            "company": "Northwest Management LLC",
            "pickup_community_area_desc": "Near North Side",
            "||fare|sum": 1370.4999997615816
        },
        {
            "company": "Northwest Management LLC",
            "pickup_community_area_desc": "O'Hare",
            "||fare|sum": 1099.1500029563904
        },
        {
            "company": "Northwest Management LLC",
            "pickup_community_area_desc": "Loop",
            "||fare|sum": 790.3000004291537
        },
        {
            "company": "Northwest Management LLC",
            "pickup_community_area_desc": "Near West Side",
            "||fare|sum": 404.70000028610235
        },
        {
            "company": "Northwest Management LLC",
            "pickup_community_area_desc": "Garfield Ridge",
            "||fare|sum": 214.34999847412112
        },
        {
            "company": "Northwest Management LLC",
            "pickup_community_area_desc": "Lincoln Park",
            "||fare|sum": 198.94999980926522
        },
        {
            "company": "Northwest Management LLC",
            "pickup_community_area_desc": "Lake View",
            "||fare|sum": 172.9000005722045
        },
        {
            "company": "KOAM Taxi Association",
            "pickup_community_area_desc": "Near North Side",
            "||fare|sum": 654.0000009536745
        },
        {
            "company": "KOAM Taxi Association",
            "pickup_community_area_desc": "O'Hare",
            "||fare|sum": 505.8999977111816
        },
        {
            "company": "KOAM Taxi Association",
            "pickup_community_area_desc": "Loop",
            "||fare|sum": 363.14999866485596
        },
        {
            "company": "KOAM Taxi Association",
            "pickup_community_area_desc": "Near West Side",
            "||fare|sum": 159.85000133514404
        },
        {
            "company": "KOAM Taxi Association",
            "pickup_community_area_desc": "Garfield Ridge",
            "||fare|sum": 125.90000152587899
        },
        {
            "company": "KOAM Taxi Association",
            "pickup_community_area_desc": "West Town",
            "||fare|sum": 104.9000005722046
        },
        {
            "company": "Top Cab Affiliation",
            "pickup_community_area_desc": "O'Hare",
            "||fare|sum": 396.6499938964844
        },
        {
            "company": "Top Cab Affiliation",
            "pickup_community_area_desc": "Loop",
            "||fare|sum": 297.30000066757196
        },
        {
            "company": "Top Cab Affiliation",
            "pickup_community_area_desc": "Near North Side",
            "||fare|sum": 274.34999990463257
        },
        {
            "company": "Top Cab Affiliation",
            "pickup_community_area_desc": "Lake View",
            "||fare|sum": 102.85000085830693
        },
        {
            "company": "Top Cab Affiliation",
            "pickup_community_area_desc": "Near West Side",
            "||fare|sum": 66.14999961853027
        },
        {
            "company": "Top Cab Affiliation",
            "pickup_community_area_desc": "West Town",
            "||fare|sum": 46.79999971389767
        },
        {
            "company": "Chicago Medallion Leasing INC",
            "pickup_community_area_desc": "Loop",
            "||fare|sum": 123
        },
        {
            "company": "Chicago Medallion Leasing INC",
            "pickup_community_area_desc": "O'Hare",
            "||fare|sum": 120
        },
        {
            "company": "Chicago Medallion Leasing INC",
            "pickup_community_area_desc": "Near North Side",
            "||fare|sum": 111.69999980926514
        },
        {
            "company": "Chicago Medallion Leasing INC",
            "pickup_community_area_desc": "Near West Side",
            "||fare|sum": 46
        },
        {
            "company": "Chicago Medallion Leasing INC",
            "pickup_community_area_desc": "Lake View",
            "||fare|sum": 43.25
        }
    ],
    "totalRows": 97,
    "fieldNames": [
        "company",
        "pickup_community_area_desc",
        "||fare|sum"
    ]
}

The query response is a JSON object with the following properties:

  • totalRows:
    An integer representing the total number of rows available for the query without pagination. This helps determine the overall size of your dataset.

  • fieldNames:
    An array of strings that lists the names of all the fields returned by the query. These include both grouping fields and computed metric fields. For example:

    • company: The taxi company that provided the taxi ride.
    • pickup_community_area_desc: The community area where the pickup occurred.
    • ||fare|sum: The sum of fare for rides by the the company and pickup community area. Notice that the metric name is prefixed by double pipes.

  • data:
    An array of objects, where each object represents an aggregation item. For instance:

1
2
3
4
5
  {
      "company": "Chicago Medallion Leasing INC",
      "pickup_community_area_desc": "Lake View",
      "||fare|sum": 43.25
  }

Note

If you want the data in the Hierarchy Array Format (HAF), you can use the 'useHAFDataFormat' property in the AQL definition as shown below. This will convert the response to the HAF format, which is compatible with standard visualizations.

Example: 

1
2
3
4
5
6
7
8
9
cf.provider('BigQuery')
    .source('tidal-solstice-206117:Aktiun.chicago_taxi_trips')
    .groupby(group1, group2)
    .metrics(metric0)
    .set("useHAFDataFormat", true) // Convert to Hierarchy Array Format
    .element('dummy')
    .limit(100)
    .execute()
...

Group and Column-Group Aggregation

Let's examine the response of the AQL below:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
let group1 = cf.Attribute("company")
    .limit(10)
    .sort("desc", cf.Metric("fare", "sum"));
let colGroup1 = cf.Attribute("pickup_community_area_desc")
    .limit(10)
    .sort("desc", cf.Metric("fare", "sum"));
let colGroup2 = cf.Attribute("payment_type")
    .limit(10)
    .sort("desc", cf.Metric("fare", "sum"));

let metric0 = cf.Metric("fare", "sum");

cf.provider('BigQuery')
    .source('tidal-solstice-206117:Aktiun.chicago_taxi_trips')
    .groupby(group1).colgroupby(colGroup1, colGroup2)
    .metrics(metric0)
    .element('dummy')
    .limit(100)
    .execute()
    .then(function(result){
        console.log(result.data)
    })

The example response is below:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
{
    "data": [
        {
            "company": "NULL",
            "Near North Side|Cash||fare|sum": 7361.550001859665,
            "Near North Side|Credit Card||fare|sum": 4187.980004787445,
            "OHare|Credit Card||fare|sum": 4084.5100269317627,
            "Loop|Cash||fare|sum": 4164.940006494522,
            "Loop|Credit Card||fare|sum": 3843.5099992752075,
            "OHare|Cash||fare|sum": 3161.0500150322914,
            "Near West Side|Cash||fare|sum": 1917.410002231598,
            "Lake View|Cash||fare|sum": 1811.9799990653992,
            "Lincoln Park|Cash||fare|sum": 1330.8199946880338,
            "Near West Side|Credit Card||fare|sum": 1152.790001869202,
            "Lake View|Credit Card||fare|sum": 1045.8099994659422,
            "West Town|Cash||fare|sum": 879.9900009632112,
            "Garfield Ridge|Credit Card||fare|sum": 897.8500022888186,
            "Garfield Ridge|Cash||fare|sum": 489.04000139236456,
            "Lincoln Park|Credit Card||fare|sum": 579.6700010299685,
            "Near South Side|Cash||fare|sum": 602.4299964904786,
            "Uptown|Cash||fare|sum": 658.9799990653992,
            "Near South Side|Credit Card||fare|sum": 478.4999980926516,
            "West Town|Credit Card||fare|sum": 320.65000152587885,
            "Uptown|Credit Card||fare|sum": 203.34000062942528,
            "Near North Side|No Charge||fare|sum": 0,
            "OHare|No Charge||fare|sum": 0,
            "Loop|No Charge||fare|sum": 0,
            "Near West Side|No Charge||fare|sum": 0,
            "Lincoln Park|No Charge||fare|sum": 0,
            "OHare|Dispute||fare|sum": 0,
            "West Town|Unknown||fare|sum": 0,
            "Garfield Ridge|No Charge||fare|sum": 0,
            "Near North Side|Unknown||fare|sum": 0,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 0,
            "Near North Side|Prcard||fare|sum": 13.6499996185303,
            "Loop|Unknown||fare|sum": 0,
            "Lake View|Dispute||fare|sum": 0,
            "Lake View|Pcard||fare|sum": 12.75,
            "Near North Side|Pcard||fare|sum": 10.5,
            "Near South Side|No Charge||fare|sum": 0,
            "West Town|No Charge||fare|sum": 0,
            "Near West Side|Prcard||fare|sum": 7.44999980926514,
            "Near South Side|Unknown||fare|sum": 0,
            "Near West Side|Unknown||fare|sum": 0,
            "Lincoln Park|Unknown||fare|sum": 0,
            "Uptown|Unknown||fare|sum": 0
        },
        {
            "company": "Taxi Affiliation Services",
            "Near North Side|Cash||fare|sum": 6399.799998760223,
            "Near North Side|Credit Card||fare|sum": 4354.149996757507,
            "OHare|Credit Card||fare|sum": 3089.9499921798706,
            "Loop|Cash||fare|sum": 3785.3999996185307,
            "Loop|Credit Card||fare|sum": 3133.399995803833,
            "OHare|Cash||fare|sum": 2224.7499952316284,
            "Near West Side|Cash||fare|sum": 1782.0500028133392,
            "Lake View|Cash||fare|sum": 1423.200003862381,
            "Lincoln Park|Cash||fare|sum": 1282.85000371933,
            "Near West Side|Credit Card||fare|sum": 1087.9000020027163,
            "Lake View|Credit Card||fare|sum": 862.6499972343445,
            "West Town|Cash||fare|sum": 1052.5500004291534,
            "Garfield Ridge|Credit Card||fare|sum": 978.7000026702882,
            "Garfield Ridge|Cash||fare|sum": 1262.9999990463257,
            "Lincoln Park|Credit Card||fare|sum": 632.3999996185305,
            "Near South Side|Cash||fare|sum": 515.9999957084656,
            "Uptown|Cash||fare|sum": 487.1999988555906,
            "Near South Side|Credit Card||fare|sum": 474.099997520447,
            "West Town|Credit Card||fare|sum": 343.5999984741209,
            "Uptown|Credit Card||fare|sum": 165.00000143051147,
            "Near North Side|No Charge||fare|sum": 0,
            "OHare|No Charge||fare|sum": 0,
            "Loop|No Charge||fare|sum": 0,
            "Near West Side|No Charge||fare|sum": 0,
            "Lincoln Park|No Charge||fare|sum": 0,
            "OHare|Dispute||fare|sum": 0,
            "West Town|Unknown||fare|sum": 8.85000038146973,
            "Garfield Ridge|No Charge||fare|sum": 0,
            "Near North Side|Unknown||fare|sum": 23.6499996185303,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 0,
            "Near North Side|Prcard||fare|sum": 0,
            "Loop|Unknown||fare|sum": 13.5,
            "Lake View|Dispute||fare|sum": 0,
            "Lake View|Pcard||fare|sum": 0,
            "Near North Side|Pcard||fare|sum": 0,
            "Near South Side|No Charge||fare|sum": 0,
            "West Town|No Charge||fare|sum": 0,
            "Near West Side|Prcard||fare|sum": 0,
            "Near South Side|Unknown||fare|sum": 0,
            "Near West Side|Unknown||fare|sum": 3.75,
            "Lincoln Park|Unknown||fare|sum": 0,
            "Uptown|Unknown||fare|sum": 0
        },
        {
            "company": "Dispatch Taxi Affiliation",
            "Near North Side|Cash||fare|sum": 1984.9599974248556,
            "Near North Side|Credit Card||fare|sum": 1261.549997806549,
            "OHare|Credit Card||fare|sum": 1460.849998474121,
            "Loop|Cash||fare|sum": 1168.7000000476837,
            "Loop|Credit Card||fare|sum": 902.0000042915345,
            "OHare|Cash||fare|sum": 778.3000001907349,
            "Near West Side|Cash||fare|sum": 566.1499977111816,
            "Lake View|Cash||fare|sum": 356.60000038146967,
            "Lincoln Park|Cash||fare|sum": 310.6500010490419,
            "Near West Side|Credit Card||fare|sum": 408.2499966621398,
            "Lake View|Credit Card||fare|sum": 255.25,
            "West Town|Cash||fare|sum": 259.45000171661394,
            "Garfield Ridge|Credit Card||fare|sum": 58.25,
            "Garfield Ridge|Cash||fare|sum": 19.300000190734842,
            "Lincoln Park|Credit Card||fare|sum": 185.34999990463254,
            "Near South Side|Cash||fare|sum": 141.25000047683713,
            "Uptown|Cash||fare|sum": 133.60000038146975,
            "Near South Side|Credit Card||fare|sum": 109.05000019073479,
            "West Town|Credit Card||fare|sum": 174.9499998092652,
            "Uptown|Credit Card||fare|sum": 33.8499984741211,
            "Near North Side|No Charge||fare|sum": 72.86000038124621,
            "OHare|No Charge||fare|sum": 49.149999618530195,
            "Loop|No Charge||fare|sum": 68.99999856948853,
            "Near West Side|No Charge||fare|sum": 49.45000028610236,
            "Lincoln Park|No Charge||fare|sum": 40.74999952316284,
            "OHare|Dispute||fare|sum": 40.5,
            "West Town|Unknown||fare|sum": 0,
            "Garfield Ridge|No Charge||fare|sum": 0,
            "Near North Side|Unknown||fare|sum": 0,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 20.100000381469698,
            "Near North Side|Prcard||fare|sum": 0,
            "Loop|Unknown||fare|sum": 0,
            "Lake View|Dispute||fare|sum": 0,
            "Lake View|Pcard||fare|sum": 0,
            "Near North Side|Pcard||fare|sum": 0,
            "Near South Side|No Charge||fare|sum": 4.44999980926514,
            "West Town|No Charge||fare|sum": 3.25,
            "Near West Side|Prcard||fare|sum": 0,
            "Near South Side|Unknown||fare|sum": 5.65000009536743,
            "Near West Side|Unknown||fare|sum": 0,
            "Lincoln Park|Unknown||fare|sum": 0,
            "Uptown|Unknown||fare|sum": 0
        },
        {
            "company": "Blue Ribbon Taxi Association Inc.",
            "Near North Side|Cash||fare|sum": 1461.7499985694883,
            "Near North Side|Credit Card||fare|sum": 840.4000024795532,
            "OHare|Credit Card||fare|sum": 587.7000026702881,
            "Loop|Cash||fare|sum": 943.5999975204467,
            "Loop|Credit Card||fare|sum": 900.6000013351442,
            "OHare|Cash||fare|sum": 463.74999904632574,
            "Near West Side|Cash||fare|sum": 381.4999995231628,
            "Lake View|Cash||fare|sum": 599.3000016212465,
            "Lincoln Park|Cash||fare|sum": 257.5500006675721,
            "Near West Side|Credit Card||fare|sum": 178.49999856948844,
            "Lake View|Credit Card||fare|sum": 263.85000085830677,
            "West Town|Cash||fare|sum": 170.69999933242804,
            "Garfield Ridge|Credit Card||fare|sum": 115.0500011444093,
            "Garfield Ridge|Cash||fare|sum": 143.8499984741211,
            "Lincoln Park|Credit Card||fare|sum": 146.3000025749207,
            "Near South Side|Cash||fare|sum": 102.04999876022337,
            "Uptown|Cash||fare|sum": 168.9000015258789,
            "Near South Side|Credit Card||fare|sum": 60.55000019073486,
            "West Town|Credit Card||fare|sum": 86.90000009536743,
            "Uptown|Credit Card||fare|sum": 21.50000047683713,
            "Near North Side|No Charge||fare|sum": 0,
            "OHare|No Charge||fare|sum": 0,
            "Loop|No Charge||fare|sum": 0,
            "Near West Side|No Charge||fare|sum": 0,
            "Lincoln Park|No Charge||fare|sum": 0,
            "OHare|Dispute||fare|sum": 0,
            "West Town|Unknown||fare|sum": 20.1000003814697,
            "Garfield Ridge|No Charge||fare|sum": 0,
            "Near North Side|Unknown||fare|sum": 0,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 0,
            "Near North Side|Prcard||fare|sum": 0,
            "Loop|Unknown||fare|sum": 0,
            "Lake View|Dispute||fare|sum": 0,
            "Lake View|Pcard||fare|sum": 0,
            "Near North Side|Pcard||fare|sum": 0,
            "Near South Side|No Charge||fare|sum": 0,
            "West Town|No Charge||fare|sum": 0,
            "Near West Side|Prcard||fare|sum": 0,
            "Near South Side|Unknown||fare|sum": 0,
            "Near West Side|Unknown||fare|sum": 0,
            "Lincoln Park|Unknown||fare|sum": 3.25,
            "Uptown|Unknown||fare|sum": 0
        },
        {
            "company": "Choice Taxi Association",
            "Near North Side|Cash||fare|sum": 1105.599997997284,
            "Near North Side|Credit Card||fare|sum": 920.5999941825867,
            "OHare|Credit Card||fare|sum": 1241.9999933242793,
            "Loop|Cash||fare|sum": 623.050003528595,
            "Loop|Credit Card||fare|sum": 636.150004386902,
            "OHare|Cash||fare|sum": 370.15000152587885,
            "Near West Side|Cash||fare|sum": 258.99999856948847,
            "Lake View|Cash||fare|sum": 324.65000438690186,
            "Lincoln Park|Cash||fare|sum": 189.90000009536737,
            "Near West Side|Credit Card||fare|sum": 188.19999837875363,
            "Lake View|Credit Card||fare|sum": 234.84999990463248,
            "West Town|Cash||fare|sum": 60.950000286102295,
            "Garfield Ridge|Credit Card||fare|sum": 216.8999996185302,
            "Garfield Ridge|Cash||fare|sum": 62.5,
            "Lincoln Park|Credit Card||fare|sum": 100.20000028610232,
            "Near South Side|Cash||fare|sum": 62.99999904632564,
            "Uptown|Cash||fare|sum": 110.40000009536749,
            "Near South Side|Credit Card||fare|sum": 13.5,
            "West Town|Credit Card||fare|sum": 18.50000047683713,
            "Uptown|Credit Card||fare|sum": 57.99999952316284,
            "Near North Side|No Charge||fare|sum": 10.94999980926514,
            "OHare|No Charge||fare|sum": 18.4500007629395,
            "Loop|No Charge||fare|sum": 0,
            "Near West Side|No Charge||fare|sum": 0,
            "Lincoln Park|No Charge||fare|sum": 0,
            "OHare|Dispute||fare|sum": 0,
            "West Town|Unknown||fare|sum": 0,
            "Garfield Ridge|No Charge||fare|sum": 0,
            "Near North Side|Unknown||fare|sum": 0,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 0,
            "Near North Side|Prcard||fare|sum": 0,
            "Loop|Unknown||fare|sum": 0,
            "Lake View|Dispute||fare|sum": 13.25,
            "Lake View|Pcard||fare|sum": 0,
            "Near North Side|Pcard||fare|sum": 0,
            "Near South Side|No Charge||fare|sum": 0,
            "West Town|No Charge||fare|sum": 0,
            "Near West Side|Prcard||fare|sum": 0,
            "Near South Side|Unknown||fare|sum": 0,
            "Near West Side|Unknown||fare|sum": 0,
            "Lincoln Park|Unknown||fare|sum": 0,
            "Uptown|Unknown||fare|sum": 0
        },
        {
            "company": "Northwest Management LLC",
            "Near North Side|Cash||fare|sum": 852.1999990940095,
            "Near North Side|Credit Card||fare|sum": 481.25000047683716,
            "OHare|Credit Card||fare|sum": 808.9500007629395,
            "Loop|Cash||fare|sum": 454.3500003814698,
            "Loop|Credit Card||fare|sum": 329.8999998569489,
            "OHare|Cash||fare|sum": 259.950002193451,
            "Near West Side|Cash||fare|sum": 265.7000012397767,
            "Lake View|Cash||fare|sum": 109.59999990463253,
            "Lincoln Park|Cash||fare|sum": 103.0500006675721,
            "Near West Side|Credit Card||fare|sum": 130.94999885559082,
            "Lake View|Credit Card||fare|sum": 63.300000667571965,
            "West Town|Cash||fare|sum": 97.79999923706058,
            "Garfield Ridge|Credit Card||fare|sum": 132,
            "Garfield Ridge|Cash||fare|sum": 82.3499984741211,
            "Lincoln Park|Credit Card||fare|sum": 95.89999914169313,
            "Near South Side|Cash||fare|sum": 94.5499992370605,
            "Uptown|Cash||fare|sum": 26.8000001907349,
            "Near South Side|Credit Card||fare|sum": 31.24999952316284,
            "West Town|Credit Card||fare|sum": 16.10000038146973,
            "Uptown|Credit Card||fare|sum": 53.74999904632564,
            "Near North Side|No Charge||fare|sum": 37.0500001907349,
            "OHare|No Charge||fare|sum": 30.25,
            "Loop|No Charge||fare|sum": 6.05000019073486,
            "Near West Side|No Charge||fare|sum": 8.05000019073486,
            "Lincoln Park|No Charge||fare|sum": 0,
            "OHare|Dispute||fare|sum": 0,
            "West Town|Unknown||fare|sum": 0,
            "Garfield Ridge|No Charge||fare|sum": 0,
            "Near North Side|Unknown||fare|sum": 0,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 0,
            "Near North Side|Prcard||fare|sum": 0,
            "Loop|Unknown||fare|sum": 0,
            "Lake View|Dispute||fare|sum": 0,
            "Lake View|Pcard||fare|sum": 0,
            "Near North Side|Pcard||fare|sum": 0,
            "Near South Side|No Charge||fare|sum": 5.44999980926514,
            "West Town|No Charge||fare|sum": 0,
            "Near West Side|Prcard||fare|sum": 0,
            "Near South Side|Unknown||fare|sum": 0,
            "Near West Side|Unknown||fare|sum": 0,
            "Lincoln Park|Unknown||fare|sum": 0,
            "Uptown|Unknown||fare|sum": 0
        },
        {
            "company": "KOAM Taxi Association",
            "Near North Side|Cash||fare|sum": 458.1000003814698,
            "Near North Side|Credit Card||fare|sum": 188.65000057220468,
            "OHare|Credit Card||fare|sum": 325.44999313354487,
            "Loop|Cash||fare|sum": 250.55000066757208,
            "Loop|Credit Card||fare|sum": 112.59999799728386,
            "OHare|Cash||fare|sum": 180.45000457763672,
            "Near West Side|Cash||fare|sum": 122.85000133514403,
            "Lake View|Cash||fare|sum": 63.59999990463259,
            "Lincoln Park|Cash||fare|sum": 63.6000003814698,
            "Near West Side|Credit Card||fare|sum": 37,
            "Lake View|Credit Card||fare|sum": 24.0500001907349,
            "West Town|Cash||fare|sum": 80.55000019073486,
            "Garfield Ridge|Credit Card||fare|sum": 98.90000152587899,
            "Garfield Ridge|Cash||fare|sum": 0,
            "Lincoln Park|Credit Card||fare|sum": 25,
            "Near South Side|Cash||fare|sum": 17.69999980926513,
            "Uptown|Cash||fare|sum": 27.149999141693073,
            "Near South Side|Credit Card||fare|sum": 5.44999980926514,
            "West Town|Credit Card||fare|sum": 24.35000038146973,
            "Uptown|Credit Card||fare|sum": 0,
            "Near North Side|No Charge||fare|sum": 7.25,
            "OHare|No Charge||fare|sum": 0,
            "Loop|No Charge||fare|sum": 0,
            "Near West Side|No Charge||fare|sum": 0,
            "Lincoln Park|No Charge||fare|sum": 0,
            "OHare|Dispute||fare|sum": 0,
            "West Town|Unknown||fare|sum": 0,
            "Garfield Ridge|No Charge||fare|sum": 27,
            "Near North Side|Unknown||fare|sum": 0,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 0,
            "Near North Side|Prcard||fare|sum": 0,
            "Loop|Unknown||fare|sum": 0,
            "Lake View|Dispute||fare|sum": 0,
            "Lake View|Pcard||fare|sum": 0,
            "Near North Side|Pcard||fare|sum": 0,
            "Near South Side|No Charge||fare|sum": 0,
            "West Town|No Charge||fare|sum": 0,
            "Near West Side|Prcard||fare|sum": 0,
            "Near South Side|Unknown||fare|sum": 0,
            "Near West Side|Unknown||fare|sum": 0,
            "Lincoln Park|Unknown||fare|sum": 0,
            "Uptown|Unknown||fare|sum": 0
        },
        {
            "company": "Top Cab Affiliation",
            "Near North Side|Cash||fare|sum": 175.64999961853025,
            "Near North Side|Credit Card||fare|sum": 98.7000002861023,
            "OHare|Credit Card||fare|sum": 207.149995803833,
            "Loop|Cash||fare|sum": 155.3000011444091,
            "Loop|Credit Card||fare|sum": 141.99999952316287,
            "OHare|Cash||fare|sum": 189.4999980926514,
            "Near West Side|Cash||fare|sum": 18,
            "Lake View|Cash||fare|sum": 78.90000057220459,
            "Lincoln Park|Cash||fare|sum": 4.5,
            "Near West Side|Credit Card||fare|sum": 48.14999961853027,
            "Lake View|Credit Card||fare|sum": 23.95000028610233,
            "West Town|Cash||fare|sum": 46.79999971389767,
            "Garfield Ridge|Credit Card||fare|sum": 0,
            "Garfield Ridge|Cash||fare|sum": 28.0499992370605,
            "Lincoln Park|Credit Card||fare|sum": 6.25,
            "Near South Side|Cash||fare|sum": 16.94999980926514,
            "Uptown|Cash||fare|sum": 0,
            "Near South Side|Credit Card||fare|sum": 25.5,
            "West Town|Credit Card||fare|sum": 0,
            "Uptown|Credit Card||fare|sum": 0,
            "Near North Side|No Charge||fare|sum": 0,
            "OHare|No Charge||fare|sum": 0,
            "Loop|No Charge||fare|sum": 0,
            "Near West Side|No Charge||fare|sum": 0,
            "Lincoln Park|No Charge||fare|sum": 0,
            "OHare|Dispute||fare|sum": 0,
            "West Town|Unknown||fare|sum": 0,
            "Garfield Ridge|No Charge||fare|sum": 0,
            "Near North Side|Unknown||fare|sum": 0,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 0,
            "Near North Side|Prcard||fare|sum": 0,
            "Loop|Unknown||fare|sum": 0,
            "Lake View|Dispute||fare|sum": 0,
            "Lake View|Pcard||fare|sum": 0,
            "Near North Side|Pcard||fare|sum": 0,
            "Near South Side|No Charge||fare|sum": 0,
            "West Town|No Charge||fare|sum": 0,
            "Near West Side|Prcard||fare|sum": 0,
            "Near South Side|Unknown||fare|sum": 0,
            "Near West Side|Unknown||fare|sum": 0,
            "Lincoln Park|Unknown||fare|sum": 0,
            "Uptown|Unknown||fare|sum": 0
        },
        {
            "company": "Chicago Medallion Leasing INC",
            "Near North Side|Cash||fare|sum": 75.94999980926514,
            "Near North Side|Credit Card||fare|sum": 35.75,
            "OHare|Credit Card||fare|sum": 77.5,
            "Loop|Cash||fare|sum": 82.75,
            "Loop|Credit Card||fare|sum": 40.25,
            "OHare|Cash||fare|sum": 42.5,
            "Near West Side|Cash||fare|sum": 28.75,
            "Lake View|Cash||fare|sum": 30.75,
            "Lincoln Park|Cash||fare|sum": 14.75,
            "Near West Side|Credit Card||fare|sum": 17.25,
            "Lake View|Credit Card||fare|sum": 12.5,
            "West Town|Cash||fare|sum": 0,
            "Garfield Ridge|Credit Card||fare|sum": 0,
            "Garfield Ridge|Cash||fare|sum": 0,
            "Lincoln Park|Credit Card||fare|sum": 7.25,
            "Near South Side|Cash||fare|sum": 10.75,
            "Uptown|Cash||fare|sum": 0,
            "Near South Side|Credit Card||fare|sum": 0,
            "West Town|Credit Card||fare|sum": 0,
            "Uptown|Credit Card||fare|sum": 0,
            "Near North Side|No Charge||fare|sum": 0,
            "OHare|No Charge||fare|sum": 0,
            "Loop|No Charge||fare|sum": 0,
            "Near West Side|No Charge||fare|sum": 0,
            "Lincoln Park|No Charge||fare|sum": 0,
            "OHare|Dispute||fare|sum": 0,
            "West Town|Unknown||fare|sum": 0,
            "Garfield Ridge|No Charge||fare|sum": 0,
            "Near North Side|Unknown||fare|sum": 0,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 0,
            "Near North Side|Prcard||fare|sum": 0,
            "Loop|Unknown||fare|sum": 0,
            "Lake View|Dispute||fare|sum": 0,
            "Lake View|Pcard||fare|sum": 0,
            "Near North Side|Pcard||fare|sum": 0,
            "Near South Side|No Charge||fare|sum": 0,
            "West Town|No Charge||fare|sum": 0,
            "Near West Side|Prcard||fare|sum": 0,
            "Near South Side|Unknown||fare|sum": 0,
            "Near West Side|Unknown||fare|sum": 0,
            "Lincoln Park|Unknown||fare|sum": 0,
            "Uptown|Unknown||fare|sum": 0
        },
        {
            "company": "Chicago Medallion Management",
            "Near North Side|Cash||fare|sum": 48.69999980926513,
            "Near North Side|Credit Card||fare|sum": 102.34999990463257,
            "OHare|Credit Card||fare|sum": 45.25,
            "Loop|Cash||fare|sum": 71.00000047683716,
            "Loop|Credit Card||fare|sum": 11.34999990463257,
            "OHare|Cash||fare|sum": 0,
            "Near West Side|Cash||fare|sum": 8.25,
            "Lake View|Cash||fare|sum": 0,
            "Lincoln Park|Cash||fare|sum": 0,
            "Near West Side|Credit Card||fare|sum": 0,
            "Lake View|Credit Card||fare|sum": 20.55000019073486,
            "West Town|Cash||fare|sum": 12.0500001907349,
            "Garfield Ridge|Credit Card||fare|sum": 27.25,
            "Garfield Ridge|Cash||fare|sum": 0,
            "Lincoln Park|Credit Card||fare|sum": 0,
            "Near South Side|Cash||fare|sum": 0,
            "Uptown|Cash||fare|sum": 0,
            "Near South Side|Credit Card||fare|sum": 0,
            "West Town|Credit Card||fare|sum": 0,
            "Uptown|Credit Card||fare|sum": 0,
            "Near North Side|No Charge||fare|sum": 0,
            "OHare|No Charge||fare|sum": 0,
            "Loop|No Charge||fare|sum": 0,
            "Near West Side|No Charge||fare|sum": 0,
            "Lincoln Park|No Charge||fare|sum": 0,
            "OHare|Dispute||fare|sum": 0,
            "West Town|Unknown||fare|sum": 0,
            "Garfield Ridge|No Charge||fare|sum": 0,
            "Near North Side|Unknown||fare|sum": 0,
            "OHare|Unknown||fare|sum": 0,
            "Lake View|No Charge||fare|sum": 0,
            "Near North Side|Prcard||fare|sum": 0,
            "Loop|Unknown||fare|sum": 0,
            "Lake View|Dispute||fare|sum": 0,
            "Lake View|Pcard||fare|sum": 0,
            "Near North Side|Pcard||fare|sum": 0,
            "Near South Side|No Charge||fare|sum": 0,
            "West Town|No Charge||fare|sum": 6.44999980926514,
            "Near West Side|Prcard||fare|sum": 0,
            "Near South Side|Unknown||fare|sum": 0,
            "Near West Side|Unknown||fare|sum": 0,
            "Lincoln Park|Unknown||fare|sum": 0,
            "Uptown|Unknown||fare|sum": 0
        }
    ],
    "totalRows": 10,
    "fieldNames": [
        "company",
        "Near North Side|Cash||fare|sum",
        "Near North Side|Credit Card||fare|sum",
        "OHare|Credit Card||fare|sum",
        "Loop|Cash||fare|sum",
        "Loop|Credit Card||fare|sum",
        "OHare|Cash||fare|sum",
        "Near West Side|Cash||fare|sum",
        "Lake View|Cash||fare|sum",
        "Lincoln Park|Cash||fare|sum",
        "Near West Side|Credit Card||fare|sum",
        "Lake View|Credit Card||fare|sum",
        "West Town|Cash||fare|sum",
        "Garfield Ridge|Credit Card||fare|sum",
        "Garfield Ridge|Cash||fare|sum",
        "Lincoln Park|Credit Card||fare|sum",
        "Near South Side|Cash||fare|sum",
        "Uptown|Cash||fare|sum",
        "Near South Side|Credit Card||fare|sum",
        "West Town|Credit Card||fare|sum",
        "Uptown|Credit Card||fare|sum",
        "Near North Side|No Charge||fare|sum",
        "OHare|No Charge||fare|sum",
        "Loop|No Charge||fare|sum",
        "Near West Side|No Charge||fare|sum",
        "Lincoln Park|No Charge||fare|sum",
        "OHare|Dispute||fare|sum",
        "West Town|Unknown||fare|sum",
        "Garfield Ridge|No Charge||fare|sum",
        "Near North Side|Unknown||fare|sum",
        "OHare|Unknown||fare|sum",
        "Lake View|No Charge||fare|sum",
        "Near North Side|Prcard||fare|sum",
        "Loop|Unknown||fare|sum",
        "Lake View|Dispute||fare|sum",
        "Lake View|Pcard||fare|sum",
        "Near North Side|Pcard||fare|sum",
        "Near South Side|No Charge||fare|sum",
        "West Town|No Charge||fare|sum",
        "Near West Side|Prcard||fare|sum",
        "Near South Side|Unknown||fare|sum",
        "Near West Side|Unknown||fare|sum",
        "Lincoln Park|Unknown||fare|sum",
        "Uptown|Unknown||fare|sum"
    ]
}

The query response is a JSON object with the following properties:

  • totalRows:
    An integer representing the total number of rows available for the query without pagination. This helps determine the overall size of your dataset.

  • fieldNames:
    An array of strings structured as follows:

  • For Groups, a fieldName entry is the actual field name.

  • For Column Groups, a fieldName entry is the combination of column group values (pipe separated) and the metric name and operation, separated from the column group values with a double pipe.

  • data:
    An array of objects, where each object represents an aggregation item. For instance, the object below represents the aggregation for the "Chicago Medallion Management" taxi company, including the "pickup_community_area_desc" and payment type combinations for that company, plus the sum of fare for those Column Group combinations:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
      {
          "company": "Chicago Medallion Management",
          "Near North Side|Cash||fare|sum": 48.69999980926513,
          "Near North Side|Credit Card||fare|sum": 102.34999990463257,
          "OHare|Credit Card||fare|sum": 45.25,
          "Loop|Cash||fare|sum": 71.00000047683716,
          "Loop|Credit Card||fare|sum": 11.34999990463257,
          "OHare|Cash||fare|sum": 0,
          "Near West Side|Cash||fare|sum": 8.25,
          "Lake View|Cash||fare|sum": 0,
          "Lincoln Park|Cash||fare|sum": 0,
          "Near West Side|Credit Card||fare|sum": 0,
          "Lake View|Credit Card||fare|sum": 20.55000019073486,
          "West Town|Cash||fare|sum": 12.0500001907349,
          "Garfield Ridge|Credit Card||fare|sum": 27.25,
          "Garfield Ridge|Cash||fare|sum": 0,
          "Lincoln Park|Credit Card||fare|sum": 0,
          "Near South Side|Cash||fare|sum": 0,
          "Uptown|Cash||fare|sum": 0,
          "Near South Side|Credit Card||fare|sum": 0,
          "West Town|Credit Card||fare|sum": 0,
          "Uptown|Credit Card||fare|sum": 0,
          "Near North Side|No Charge||fare|sum": 0,
          "OHare|No Charge||fare|sum": 0,
          "Loop|No Charge||fare|sum": 0,
          "Near West Side|No Charge||fare|sum": 0,
          "Lincoln Park|No Charge||fare|sum": 0,
          "OHare|Dispute||fare|sum": 0,
          "West Town|Unknown||fare|sum": 0,
          "Garfield Ridge|No Charge||fare|sum": 0,
          "Near North Side|Unknown||fare|sum": 0,
          "OHare|Unknown||fare|sum": 0,
          "Lake View|No Charge||fare|sum": 0,
          "Near North Side|Prcard||fare|sum": 0,
          "Loop|Unknown||fare|sum": 0,
          "Lake View|Dispute||fare|sum": 0,
          "Lake View|Pcard||fare|sum": 0,
          "Near North Side|Pcard||fare|sum": 0,
          "Near South Side|No Charge||fare|sum": 0,
          "West Town|No Charge||fare|sum": 6.44999980926514,
          "Near West Side|Prcard||fare|sum": 0,
          "Near South Side|Unknown||fare|sum": 0,
          "Near West Side|Unknown||fare|sum": 0,
          "Lincoln Park|Unknown||fare|sum": 0,
          "Uptown|Unknown||fare|sum": 0
      }

Therefore, when using Columng Groups in your AQL, objects in the data array will include entries for those column group value combinations and their metric value in this format:

1
<colgroup_1 value> | <colgroup_2 value> || <metric_name> | <aggregation>

Note that metrics include both the metric name and the type of aggregation.

Obtaining response in HAF format

As described above, paginated aggregate queries return data using the Field‑Map Object Format (FOF) by default. To obtain results in the Hierarchy Array Format (HAF), use the "useHAFDataFormat" setting as below. This is useful when you want to inject this results directly into a standard visualization.

1
2
3
4
5
6
7
8
9
           rawQuery = cf.provider('BigQuery')
              .source(chicagoTaxiTripsSource)
              .groupby(row1)
              .colgroupby(col1)
              .metrics(metric)
              .set('useHAFDataFormat', true)
              .limit(1000)
              .element('dummy')
              .execute();

Detail format

The Detail format is used when using the .fields() function to query data. In these situations, ChartFactor understands that we are querying raw data, so it won't return an aggregated structure. Instead it will return an array of objects where each object will be a JSON representation for the rows of the table.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
var data = [
    {birthdate: "1988-3-1", name: "Barry", rating: Array(2), sport: "Baseball"},
    {birthdate: "1988-3-1", name: "Wayne", rating: Array(2), sport: "Hockey"},
    {birthdate: "1988-3-1", name: "Brady", rating: Array(2), sport: "Football"},
    {birthdate: "1992-5-20", name: "Joe", rating: Array(2), sport: "Baseball"},
    {birthdate: "1992-5-20", name: "Ping", rating: Array(2), sport: "Baseball"},
    {birthdate: "1990-9-9", name: "Hal", rating: Array(2), sport: "Baseball"},
    {birthdate: "1990-9-9", name: "Alfred", rating: Array(2), sport: "Baseball"},
    {birthdate: "1989-10-1", name: "Mick", rating: Array(2), sport: "Baseball"}
]