LogoLogo
  • 📣Welcome!
  • ☑️Quick Start
  • ✔️Terms, Definitions, Abbreviations & Regulations
    • Terms
    • Definitions
      • ✔️Entity
      • ✔️Entity Class
      • ✔️Memory Class
      • ✔️Authentication Key
    • Abbreviations
    • Regulations
  • 🚩Essentials
    • ✔️Entity Classes
      • ✔️Brand
      • ✔️User
        • ✔️Password
        • ✔️Username
        • ✔️Accounts
        • ✔️Referral
        • ✔️User Notification
        • ✔️Usage
      • ✔️Device
      • ✔️Plans & Pricing
        • ✔️License
          • ✔️Usage
        • ✔️Package
        • ✔️Feature
        • ✔️Configuration
        • ✔️Price
        • ✔️Coupon
      • ✔️Payment-Related
        • ✔️Payment
        • ✔️Payment History
        • ✔️Payment Method
        • ✔️Wallet
      • ✔️Point-Related
        • ✔️Point
        • ✔️Point Event
        • ✔️Point History
        • ✔️Point Reward
      • ✔️Role-Based Access Control (RBAC)
        • ✔️Role
        • ✔️Permission
      • ✔️Tracking-Related
        • ✔️Tracking event
        • ✔️Tracking activity
        • ✔️Tracking email
        • ✔️Email pattern
        • ✔️Helpdesk
      • ✔️System Configuration
        • ✔️SMTP Setting
        • ✔️Blacklist
        • ✔️Configuration
        • ✔️External authentication provider
        • ✔️Payment Provider
      • ✔️System Definition
        • ✔️Country
        • ✔️State
        • ✔️City
        • ✔️Currency
        • ✔️Language
        • ✔️Time Zone
    • ✔️Memory Classes
      • ✔️Event Class
      • ✔️Token Service Class
      • ✔️Error Manager
      • ✔️Session Manager
      • ✔️Version
      • ✔️Mail Service
      • ✔️CDN Service
    • ✅Third-party APIs
      • Webhooks
  • 🎯Guide
    • ✔️Login with Google
    • Integrate i18n
    • Integrate reCAPTCHA
  • References
    • Design Specifications
      • System Definitions
        • Country
        • State
        • City
        • Time Zone
        • Currency
        • Language
      • System Configurations
        • Configuration
        • External Login Provider
        • Payment Provider
        • BlackList
        • CDN
        • Address
      • Soft Deletion
        • Brand
          • Brand Email
          • Brand Link
          • Brand Profile
          • Brand Setting
        • User
          • User Profile
          • User Setting
        • Device
          • Device Profile
      • Role-Based Access Control
        • Role
        • Permission
      • Plans & Pricing
        • Feature
        • License
        • configuration
        • Package
        • Coupon
        • Price
      • Payment-Related
        • Payment
        • Payment Method
        • Payment History
        • Wallet
      • Point-Related
        • Point
        • Point Event
        • Point History
      • Tracking-Related
        • Tracking Activity
        • Tracking Event
        • Tracking Email
        • Tracking Email Pattern
        • Tracking Email Read
        • Helpdesk
        • Helpdesk Feedback
      • Relationships
        • Coupon - User
        • External Login Provider - User
        • Package - Feature
        • Role - Permission
    • ✔️JFW API
      • Overview
      • Authentication
      • Rate Limiting
      • Errors
      • API Reference
        • App Integrations
          • Get apps integration
          • Authentication
            • Creates an app integration authentication
            • Deletes an app integration authentication
            • Gets an app integration authentication
            • Get apps integration authentication with brand
            • Test building an authentication URL
            • Updates an app integration authentication
          • Payment Gateway
            • Create an app integration payment gateway
            • Delete an app integration payment gateway
            • Get an app integration payment gateway
            • Get apps integration payment gateway with brand
            • Test creating a checkout link
            • Update an app integration payment gateway
          • Push Notification
            • Create an app integration push notification
            • Delete an app integration push notification
            • Get an app integration push notification
            • Get an app integration push notification with brand
            • Update an app integration push notification
          • SMS
            • Create an app integration SMS
            • Delete an app integration SMS
            • Get an app integration SMS
            • Get apps integration SMS with brand
            • Test sending an SMS message
            • Update an app integration SMS
          • SMTP
            • Create an app integration SMTP
            • Delete an app integration SMTP
            • Get an app integration SMTP
            • Get apps integration SMTP with brand
            • Test sending an email message
            • Update an app integration SMTP
        • Brands
          • Check domain if exists
          • Create a brand
          • Create a link with a brand
          • Delete a link for a brand
          • Generate a new domain
          • Get a brand
          • Get a brand by url
          • Get brands
          • Get a link
          • Get links by type
          • Get links
          • Update a link
          • Update a brand
          • Get emails with a brand
          • Update a brand's profile
          • Update a brand's setting
          • Update a email
        • CDN
          • Delete a file CDN
          • Get a file CDN
          • Get files CDN
          • Upload a file CDN
        • Cities
        • Commission rate
          • Creates a commission rate
          • Deletes a commission rate
          • Gets a commission rate
          • Gets discount value
          • Get commission rates
          • Updates a commission rate
        • Configurations
          • Create a configuration
          • Delete a configuration
          • Get configurations
          • Get a configuration
          • Update a configuration
        • Constants
          • Brand Link
          • Black List
          • Coupon
          • Commission Rate
          • Device
          • Invoice
          • Issue
          • License
          • Organization
          • Payment
          • Transaction
          • Tracking Event
          • Tracking Notification
          • Feature
          • User
          • Wallet
          • Error
        • Coupons
          • Create a Coupon
          • Delete a Coupon
          • Get a Coupon
          • Get Coupons (*)
          • Update a Coupon
        • Cryptographies
          • Decrypt
          • Encrypt
        • Countries
        • Currencies
        • Devices
          • Checks user access device
          • Create a device
          • Delete a device
          • Get a device
          • Get current device of the user authorized
          • Get devices
          • Statistics
          • Update a device
        • Domains
          • Get domains
        • Events
          • Get email template default by event
          • Get an email template by event
          • Get events
          • Get events earning wallet
          • Get events that are associated with email templates
          • Get events that are associated with phone templates
          • Get phone template by event
          • Get phone template default by event
        • Exchange rates
          • Get exchange rates
          • Convert currency
        • Email Template
          • Create an email template
          • Delete an email template
          • Get an email template
          • Get email templates
          • Gets all placeholder keys available
          • Update an email template
        • Features
          • Create a feature
          • Delete a feature
          • Get a feature
          • Get features
          • Update a feature
        • Invoices
          • Delete an invoice
          • Get invoices
          • Get an invoice
          • Export an invoice
        • Issue categories
          • Create an issue category
          • Delete an issue category
          • Get issue categories
          • Get an issue category
          • Update an issue category
        • Issues
          • Create an issue
          • Create an issue reaction
          • Delete an issue
          • Delete an issue reaction
          • Get issues
          • Get an issue
          • Get issues by list id
          • Get children issues
          • Update an issue
        • Languages
        • Licenses
          • Applies a license to the logged user
          • Applies a license to the given login name
          • Applies a license to the given a user
          • Checks a license key
          • Create the licenses
          • Count licenses created
          • Delete a license
          • Get licenses
          • Get a license
          • Generate license key
          • Purchase to add licenses by checkout link
          • Purchase to add licenses by wallet
          • Statistics the percentage licenses used
        • MFA
          • Get a list of MFA
        • Organizations
          • Adds a new user to the organization
          • Adds a user for default language code organization system
          • Assign role for a user in an organization
          • Creates an organization
          • Deletes an organization
          • Get an organization
          • Get organizations
          • Get users of an organization
          • Remove a user in an organization
          • Updates an organization
          • Updates users status in an organization
        • Notifications
          • Delete a notification
          • Get notifications by the user authorized
          • Mark a notification as read
          • Push notification message for tokens
          • Push notification data message by the given device codes
          • Push notification data message by tokens
          • Push notification data message by devices
          • Updates all notification
          • Updates status notifications
          • Updates status of a notification
        • Packages
          • Add features to a package
          • Create a package
          • Delete a package
          • Get a package
          • Get packages
          • Get prices from a package
          • Update a package
          • Remove features from a package
        • Payments
          • Get a payment
          • Get payments
          • Gets the overview Sell Dashboar
        • Permissions
          • Add roles to a permission
          • Create a permission
          • Delete a permission
          • Get a permission
          • Get permissions
          • Update a permission
        • Prices
          • Create a price
          • Delete a price
          • Generate checkout link
          • Get a price
          • Get prices
          • Update a price
        • Resource types
          • Create a resource type
          • Delete a resource type
          • Get a resource type
          • Get resource types
          • Update a resource type
        • Roles
          • Assign users to a role
          • Delete a role
          • Create a role
          • Get a role
          • Get roles
          • Grants permissions to a role
          • Get permissions granted by role
          • Remove permissions from a role
          • Update a role
        • States
        • Subscription types
          • Create a subscription type
          • Delete a subscription type
          • Get a subscription type
          • Get subscription types
          • Update a subscription type
        • Time zones
        • Tracking Activities
          • Get activities (*)
          • Get a activity
        • Tracking emails
          • Get a tracking email
          • Get tracking emails
        • Users
          • Activate a user
          • Add a device to a user
          • Applies the referral code to a user
          • Assigns roles to a user
          • Authentication by Apple
          • Authentication by email OTP
          • Authentication by Google
          • Authentication by magic link
          • Authentication by SMS OTP
          • Authentication
          • Change password
          • Check referral user code
          • Configurations
          • Deactive a user
          • Delete a user
          • Email address verification
          • Forgot password
          • Get a user by username
          • Get a user
          • Get devices from a user
          • Get users
          • Gets the current user logged in
          • Gets the referees of a user
          • List all the brand partners authenticate
          • Lock a user
          • Register a new user
          • Remove a device from a user
          • Reset password
          • Revokes roles to a user
          • Statistics users
          • Suspend a user
          • Unlock a user
          • Unsuspend a user
          • Update a user
          • Update user type
          • Verify email address OTP to authentication
          • Verify SMS OTP to authentication
        • Wallets
          • Add money to a Wallet with checkout link
          • Apply redeem code
          • Create a wallet default
          • Convert wallet money
          • Close wallet
          • Get wallets
          • Get the wallet histories
      • Libraries
        • Javascript
        • Dot Net
        • Flutter
  • ☑️Change logs
  • ❔Questions & Feedback
  • References
Powered by GitBook
On this page

Was this helpful?

  1. References
  2. Design Specifications
  3. Tracking-Related

Tracking Event

Tracking events are used to track interactions and activities within the system. These events can be used to monitor user behavior, system performance, and other important metrics.

Table Structure
  • [ID] (bigint, auto-incrementing, primary key): Represents the unique identifier for each tracking event record.

  • [Group_Code] (varchar(150), not null): Represents the group code of the tracking event.

  • [Code] (varchar(150), not null): Represents the code of the tracking event.

  • [Name] (nvarchar(500), nullable): Represents the name of the tracking event.

  • [Description] (nvarchar(2048), nullable): Represents the description of the tracking event.

  • [Tracking_Level] (smallint, not null): Represents the tracking level of the tracking event.

  • [ZOrder] (bigint, nullable): Represents the z-order of the tracking event.

  • [Status] (smallint, not null): Represents the status of the tracking event.

  • [Is_System] (bit, not null): Indicates whether the tracking event is a system event.

  • [Modified_By] (bigint, nullable): Represents the user who last modified the tracking event.

  • [Modified_Date] (datetime, not null): Represents the date and time when the tracking event was last modified.

  • [Created_By] (bigint, nullable): Represents the user who created the tracking event.

  • [Created_Date] (datetime, not null): Represents the date and time when the tracking event was created.

Constraints
  • [PK_Pattern]: primary key constraint on the [ID] column.

  • [DF_TrackingEvent_Tracking_Level]: default constraint on the [Tracking_Level] column with a default value of 0.

  • [DF_Pattern_IsSystem]: default constraint on the [Is_System] column with a default value of 0.

  • [DF_Pattern_ModifiedDate]: default constraint on the [Modified_Date] column with the current UTC date and time as the default value.

  • [DF_Pattern_CreatedDate]: default constraint on the [Created_Date] column with the current UTC date and time as the default value.

Example Usage

Group_Code
Code
Name
Description
Tracking_Level
ZOrder
Status
Is_System

ACCOUNT

REGISTRATION

User Registration

User registers an account

1

1000

1

1

ACCOUNT

REGISTRATION-SUCCESS

User Registration Success

User successfully registers an account

1

1000

2

1

ACCOUNT

FORGOT-PASSWORD-1

Forgot Password

User attempts to reset password

1

1000

1

1

ACCOUNT

FORGOT-PASSWORD-NOT-EXISTED

Forgot Password - User Not Existed

User attempts to reset password but user does not exist

1

1000

2

1

ACCOUNT

CHANGE-PASSWORD

Change Password

User changes password

1

1000

1

1

ACCOUNT

EMAIL-TO-EXPIRED-USER

Email to Expired User

Email sent to expired user

1

1000

1

1

ACCOUNT

EMAIL-TO-USER-WILL-BE-EXPIRED

Email to User Will Be Expired

Email sent to user who will be expired

1

1000

1

1

ACCOUNT

EMAIL-TO-EXPIRED-USER-TO-DEACTIVE

Email to Expired User to Deactive

Email sent to expired user to deactivate

1

1000

1

1

ACCOUNT

EMAIL-TO-USER-ABOUT-ACCOUNT-INFO-CHANGED

Email to User About Account Info Changed

Email sent to user about account info changed

1

1000

1

1

ACCOUNT

EMAIL-TO-ASK-USER-AFTER-PAYMENT

Email to Ask User After Payment

Email sent to user after payment

1

1000

1

1

ACCOUNT

LOGIN-SUCCESS-NOTIFICATION

Login Success Notification

Notification sent after successful login

1

1000

1

1

ACCOUNT

SEND-EMAIL-WITH-USER-STATUS-DELETED

Send Email with User Status Deleted

Email sent with user status deleted

1

1000

1

1

ACCOUNT

SEND-THE-EMAIL-TO-INACTIVE-USER

Send the Email to Inactive User

Email sent to inactive user

1

1000

1

1

ACCOUNT

SIGN-IN-DETECTION

Sign-in Detection

Detection of user sign-in

1

1000

1

1

ACCOUNT

SEND-VERIFICATION-EMAIL

Send Verification Email

Email sent for verification

1

1000

1

1

ACCOUNT

RESET-PASSWORD

Reset Password

User resets password

1

1000

1

1

ACCOUNT

SEND-EMAIL-TO-USER-ABOUT-COUPON

Send Email to User About Coupon

Email sent to user about coupon

1

1000

1

1

ACCOUNT

SEND-EMAIL-A-TICKET-TO-USER

Send Email a Ticket to User

Email sent a ticket to user

1

1000

1

1

PURCHASE

REMOVE-ACCOUNT

Remove Account

Remove user account

1

1000

1

1

PURCHASE

DISCOUNT-COUPON

Discount Coupon

Discount coupon applied

1

1000

1

1

PURCHASE

ORDER-INFO-AFTER-PAID

Order Info After Paid

Order information after payment

1

1000

1

1

PURCHASE

THANKS-FOR-PURCHASE

Thanks for Purchase

Thank you message after purchase

1

1000

1

1

PURCHASE

THANKS-FOR-PURCHASE-WITH-LICNESE-CODE

Thanks for Purchase with License Code

Thank you message after purchase with license code

1

1000

1

1

PURCHASE

APPLY-LICENSE-SUCCESSSFULLY

Apply License Successfully

License applied successfully

1

1000

1

1

PURCHASE

PURCHASE-NOTIFICATION

Purchase Notification

Notification after purchase

1

1000

1

1

SUPPORT

EXCEPTION-TO-DEV

Exception to Dev

Exception sent to developer

1

1000

1

1

SUPPORT

MESSAGE-TO-SUPPORT-TEAM

Message to Support Team

Message sent to support team

1

1000

1

1

EMAIL EXAMPLE

SEND-EMAIL-TEST-SMTP

Send Email Test SMTP

Send email test SMTP

1

1000

1

1

PURCHASE

PURCHASE-NOTIFICATION-SUCCESSFULLY

Purchase Notification Successfully

Notification after successful purchase

1

1000

1

1

PURCHASE

SEND-INVOICE-TO-USER

Send Invoice to User

Send invoice to user

1

1000

1

1

EXPORT DATA

EXPORT-INVOICE-PDF

Export Invoice PDF

Export invoice to PDF

1

1000

1

1

ACCOUNT

FORGOT-PASSWORD

Forgot Password

User forgot password

1

1000

1

1

ACCOUNT

REGISTRATION-CONFIRMATION

Registration Confirmation

User registration confirmation

1

1000

1

1

PURCHASE

PURCHASE-LICENSE-DIRECT-APPLY

Purchase License Direct Apply

Purchase license directly applied

1

1000

1

1

PURCHASE

PURCHASE-LICENSE-KEY

Purchase License Key

Purchase license key

1

1000

1

1

PURCHASE

REDEEM-GIFT

Redeem Gift

Redeem gift

1

1000

1

1

ACCOUNT

INVITE-FRIEND-VIA-CODE

Invite Friend via Code

Invite friend via code

1

1000

1

1

ACCOUNT

INVITE-FREIND-VIA-LINK

Invite Friend via Link

Invite friend via link

1

1000

1

1

MAINTENANCE

UPDATE-VERSION

Update Version

Update version

1

1000

1

1

MAINTENANCE

POLICY

Policy

Policy

1

1000

1

1

PreviousTracking ActivityNextTracking Email

Last updated 1 year ago

Was this helpful?