Gift Card Data Pipeline
The gift cards dataset includes historical information on gift cards that have been created or modified. This dataset only provides information on gift cards created natively within VTEX, using the Giftcard API.
Gift cards created through customized or external apps will not appear in this data model.
This section includes the following information:
- Gift card data characteristics
- Table gift_cards_events_raw
- Analyses with gift cards
- Correlations with other data
Data Characteristics
| Characteristic | Description |
|---|---|
| Data source | Obtained from information in the Audit. |
| Availability | VTEX Admin. |
| History | Data is maintained for two years, starting in 2024 for customers already using the VTEX platform. |
| Minimum update interval | One hour. |
Table: gift_cards_events_raw
Below are the fields that constitute the table:
| Column Name | Column Type | Column Description |
|---|---|---|
| account_name | character varying(255) | Name of the account related to the gift card operation. |
| event_date | timestamp with time zone | Date and time of the given operation. |
| operation | character varying(200) | Type of operation. |
| subject_id | character varying(200) | Subtype of operation. |
| author_id | character varying(1000) | Author of the operation. |
| giftcardid | character varying(5000) | Id of the gift card used on the operation. Only available for operations CREATE_GIFT_CARD or EDIT_GIFT_CARD. |
| giftcardvalue | character varying(5000) | Value of the gift card used on the operation. Only available for operations CREATE_GIFT_CARD or EDIT_GIFT_CARD. |
| edit_initial_value | character varying(5000) | Initial value of the gift card, before the edit operation. Only available for operation EDIT_GIFT_CARD. |
| edit_final_value | character varying(5000) | Final value of the gift card, after the edit operation. Only available for operation EDIT_GIFT_CARD. |
| batch_id | character varying(100) | Identifier used when data is loaded into the table for quality control of data ingestion. |
Analyses with Gift Cards
Here are some analyses you can perform with the gift cards table:
- List of Created Gift Cards: review the current list of created gift cards.
- Audit Gift Card Information: examine activities related to your gift cards, including identifying who created a specific gift card and viewing the edit history of a gift card.
Correlations with Other Data
Gift card data is related to order data, providing a comprehensive analysis of purchases and sales. Here are some examples:
- Most Used Gift Cards: Combining this data model with order data, you can understand how gift cards are being utilized and monitor their usage.
- Impact on Sales: Similarly, combining with order data allows you to assess how gift cards influence sales.