member_balance (timeseries)
| Required permit | Rate limit tokens cost | Available intervals |
|---|---|---|
| Reporting:Api:Report:MemberBalance | 3 | 5m, 1h, 1d |
in type serie is incremented.When a member is removed from loyalty club then
out type serie is decremented.Fields
community_id
| Type | Filterable |
|---|---|
| Integer | (via X-Customer header) |
type
| Type | Filterable |
|---|---|
| Enum |
in - members that opt in to loyalty clubout - members that opt out from loyalty cluboptin_channel
| Type | Filterable |
|---|---|
| String |
optin_subchannel
| Type | Filterable |
|---|---|
| String |
optin_platform
| Type | Filterable |
|---|---|
| Enum |
gender
| Type | Filterable | Readonly |
|---|---|---|
| String |
age
| Type | Filterable |
|---|---|
| Enum |
consents
| Type | Filterable |
|---|---|
| Object(key: name of consent, value: boolean status of consent) |
Query without aggregations
{
"interval": "1d",
"range_timezone": "America/Denver",
"time_buckets": [
"2024-04-08T00:00:00.000-06:00",
"2024-04-09T00:00:00.000-06:00",
"2024-04-11T00:00:00.000-06:00",
"2024-04-22T00:00:00.000-06:00",
"2024-04-23T00:00:00.000-06:00",
"2024-04-24T00:00:00.000-06:00",
"2024-04-25T00:00:00.000-06:00"
],
"series": [
{
"label": {
"type": "out"
},
"values": [
2,
2,
1,
1,
null,
1,
5
]
},
{
"label": {
"type": "in"
},
"values": [
null,
4,
300,
2,
1,
null,
11
]
}
],
"data_points": 11,
"result_type": "timeseries"
}Aggregations
total
optin_platform
Labels
| Key | Type | Description |
|---|---|---|
| optin_platform | Enum | See in Fields |
Example query response
{
"interval": "1d",
"range_timezone": "America/Denver",
"time_buckets": [
"2024-04-08T00:00:00.000-06:00",
"2024-04-09T00:00:00.000-06:00",
"2024-04-11T00:00:00.000-06:00",
"2024-04-22T00:00:00.000-06:00",
"2024-04-23T00:00:00.000-06:00",
"2024-04-24T00:00:00.000-06:00",
"2024-04-25T00:00:00.000-06:00"
],
"series": [
{
"label": {
"type": "out",
"optin_platform": "other"
},
"values": [
2,
2,
1,
1,
null,
1,
5
]
},
{
"label": {
"type": "in",
"optin_platform": "other"
},
"values": [
null,
4,
300,
2,
1,
null,
11
]
}
],
"data_points": 11,
"result_type": "timeseries"
}total_optin_platform
Modified at 2024-10-16 14:19:01