Examples:
{
"rowGroupCols": [
{
"field": "campaign_id"
}
]
}
response:
{
"data": [
{
...
"campaign_id": "2bdb6f47-ac08-34b8-9c89-6497b3be237f",
"is_sent": "4",
"is_clicked": "0",
...
},
"meta": { ... }
}
{
"rowGroupCols": [
{
"field": "country_id"
}
]
}
response:
{
"data": [
{
...
"country_id": 226,
"is_sent": "4",
"is_clicked": "0",
...
},
"meta": { ... }
}
Use show_as
to specify the group type
DateTime columns can be group by hour
, date
, year-week
, year-month
example:
{
"rowGroupCols": [
{
"field": "sent_at",
"show_as": "date"
}
]
}
response:
{
"data": [
{
...
"sent_at": "2023-08-03",
"is_sent": "230",
"is_clicked": "25",
"is_lead": "0",
"is_sale": "0",
"ctr": 10.87,
...
},
Use groupByAll
to group by all columns that are in rowGroupCols
example:
{
"rowGroupCols": [
{
"field": "sent_at",
"show_as": "date"
},
{
"field": "country_id"
}
],
"groupByAll": true
}
response:
{
"data": [
{
...
"sent_at": "2023-08-03",
"country_id": 226,
"is_sent": "210",
"is_clicked": "25",
"is_lead": "0",
"is_sale": "0",
"ctr": 11.9,
...
"sent_at": "2023-08-03",
"country_id": 13,
"is_sent": "20",
"is_clicked": "0",
"is_lead": "0",
"is_sale": "0",
"ctr": 0,
...
},
without groupByAll
parameter the response will be grouped by the first column in rowGroupCols
. .
usually this response is used for the AG-grid component:
| sent_at ______ | country_id | is_sent | is_clicked | ctr __ |
| -------------- | ---------- | ------- | ---------- | ------ |
| [+] 2023-08-03 | 2 ________ | 230 ___ | 25 _______ | 11.9 _ |
after this the user can expand the row and see the data for each country:
| sent_at ______ | country_id __ | is_sent | is_clicked | ctr_ |
--------------------------------------------------------------- |
| [-] 2023-08-03 | 2 ___________ | 230 ___ | 25 _______ | 11.9 |
--------------------------------------------------------------- |
| ______________ | 226 _________ | 210 ___ | 25 _______ | 11.9 |
--------------------------------------------------------------- |
| ______________ | 13 __________ | 20 ____ | 0 ________ | 0 __ |
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The response is of type object
.