get https://{host}/v2/pointsLedger/getLedgerExplodeInfo
Retrieves the points ledger explode info for customer/ user group.
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
eventLogId | Integer | A unique identifier for the event. |
eventName | String | The name of the event, in this case, "GenericEvent". |
eventDetails | Object | Contains details about the event. |
eventDetails.eventDisplayName | String | Display name of the event, e.g., "CupSeries2024". |
eventDetails.tillId | Integer | ID of the till where the event was recorded. |
eventDetails.displayName | String | Name to display for the event, e.g., "CUP SERIES CHECK-IN". |
pointsEarned | Object | Contains details of points earned in the event. |
pointsEarned.regular | Array | Array of regular points earned (empty in this case). |
pointsEarned.promo | Array | Array of promotional points earned during the event. |
pointsEarned.promo.promotionId | Integer | The ID of the promotion, e.g., 8166. |
pointsEarned.promo.promotionName | String | The name of the promotion, e.g., "CupSeriesatClashColiseumBuschLightTrack_4Feb-5Feb". |
pointsEarned.promo.programId | Integer | The ID of the loyalty program associated with the promotion, e.g., 1155. |
pointsEarned.promo.programName | String | The name of the loyalty program, e.g., "NASCAR LoyaltyDefaultProgram". |
pointsEarned.promo.value | Float | The value of the points earned from the promotion, e.g., 200.0. |
pointsEarned.promo.promotionStartDate | String | The start date of the promotion, e.g., "2024-02-04 00:00:00.0". |
pointsEarned.promo.promotionEndDate | String | The end date of the promotion, e.g., "2024-03-05 23:59:59.0". |
pointsEarned.promised | Array | Array of promised points (empty in this case). |
behavioralEventMetadata | Object | Metadata about the behavioral event associated with the check-in. |
behavioralEventMetadata.label | String | The label for the behavioral event, e.g., "CUP SERIES CHECK-IN". |
behavioralEventMetadata.fields | Array | An array of fields related to the event's metadata. |
behavioralEventMetadata. fields.fieldName | String | The name of the field, e.g., "activity_date". |
behavioralEventMetadata. fields.fieldType | String | The type of the field, e.g., "DATE". |
behavioralEventMetadata. fields.attributes. isRequired.valueType | String | The type of value for the isRequired attribute for the event, e.g., "BOOLEAN". This is configured during the creation of the event. |
behavioralEventMetadata.fields. attributes.isRequired.value | String | The value indicating if the field is required, e.g., "false". |
behavioralEventMetadata.fields. attributes.isUniqueKeyField.valueType | String | The type of value for the isUniqueKeyField attribute, e.g., "BOOLEAN". This is configured during the creation of the event . |
behavioralEventMetadata.fields. attributes.isUniqueKeyField.value | String | The value indicating if the field is a unique key, e.g., "false". |
eventReferenceId | String | The event request ID. This is generated when the event is sent. This helps to trace the event. |
uniqueId | String | A unique identifier for this specific event instance, e.g., "70375599-a144-4065-8db5-a6abd061ddf7". This can be the same as requestId or can be hash of the payload when the isUniqueKeyField is enabled. |