> ## Documentation Index
> Fetch the complete documentation index at: https://help.airbridge.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Airbridge Standard Events & Semantic Attributes

## Standard Events

| Standard Event Category                  | Event Category Display Name |
| ---------------------------------------- | --------------------------- |
| airbridge.user.signup                    | Sign-up                     |
| airbridge.user.signin                    | Sign-in                     |
| airbridge.user.signout                   | Sign-out                    |
| airbridge.ecommerce.home.viewed          | Home Screen                 |
| airbridge.ecommerce.productList.viewed   | Product Catalog             |
| airbridge.ecommerce.searchResults.viewed | Search Results              |
| airbridge.ecommerce.product.viewed       | Product View                |
| airbridge.addPaymentInfo                 | Add Payment Info            |
| airbridge.addToWishlist                  | Add to Wishlist             |
| airbridge.ecommerce.product.addedToCart  | Add To Cart                 |
| airbridge.initiateCheckout               | Initiate Checkout           |
| airbridge.ecommerce.order.completed      | Order Complete              |
| airbridge.ecommerce.order.canceled       | Order Cancel                |
| airbridge.startTrial                     | Start Trial                 |
| airbridge.subscribe                      | Subscribe                   |
| airbridge.unsubscribe                    | Unsubscribe                 |
| airbridge.adImpression                   | Ad Impression               |
| airbridge.adClick                        | Ad Click                    |
| airbridge.completeTutorial               | Complete Tutorial           |
| airbridge.achieveLevel                   | Achieve Level               |
| airbridge.unlockAchievement              | Unlock Achievement          |
| airbridge.rate                           | Rate                        |
| airbridge.share                          | Share                       |
| airbridge.schedule                       | Schedule                    |
| airbridge.spendCredits                   | Spend Credits               |

## Semantic Attributes

| <span style={{ display: 'inline-block', minWidth: '120px' }}>Field Name</span> | <span style={{ display: 'inline-block', minWidth: '160px' }}>Semantic Attributes Field Key</span> | <span style={{ display: 'inline-block', minWidth: '40px' }}>Type</span> | <span style={{ display: 'inline-block', minWidth: '120px' }}>Description</span>                                                                                                          | <span style={{ display: 'inline-block', minWidth: '120px' }}>Example</span>                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Total Revenue                                                                  | eventData.goal.semanticAttributes.totalValue                                                      | float                                                                   | Total Revenue                                                                                                                                                                            | 10000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Total Revenue (Original)                                                       | eventData.goal.semanticAttributes.originalTotalValue                                              | float                                                                   | Total revenue from the original data                                                                                                                                                     | 10000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Currency                                                                       | eventData.goal.semanticAttributes.currency                                                        | string                                                                  | Currency                                                                                                                                                                                 | KRW                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Currency (Original)                                                            | eventData.goal.semanticAttributes.originalCurrency                                                | string                                                                  | Original currency                                                                                                                                                                        | KRW                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Product List                                                                   | eventData.goal.semanticAttributes.products                                                        | array                                                                   | Product List                                                                                                                                                                             | \[\{<br />"productID": "5019819fje931",<br />"name": "The Shoes",<br />"price": 30000,<br />"currency": "KRW",<br />"position": 1<br />}, \{<br />"productID": "5019819fje932",<br />"name": "The Shoes 2",<br />"price": 28000,<br />"currency": "KRW",<br />"position": 2<br />}]                                                                                                                                                                                                                                                                    |
| Product ID                                                                     | eventData.goal.semanticAttributes.products.\$0.productID                                          | string                                                                  | Product ID                                                                                                                                                                               | 30372425                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Product Name                                                                   | eventData.goal.semanticAttributes.products.\$0.name                                               | string                                                                  | Product Name                                                                                                                                                                             | The Shoes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Product Price                                                                  | eventData.goal.semanticAttributes.products.\$0.price                                              | float                                                                   | Product Price                                                                                                                                                                            | 1000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Product Quantity                                                               | eventData.goal.semanticAttributes.products.\$0.quantity                                           | int                                                                     | Product Quantity                                                                                                                                                                         | 1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Product Currency                                                               | eventData.goal.semanticAttributes.products.\$0.currency                                           | string                                                                  | Product Currency                                                                                                                                                                         | KRW                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Product Position                                                               | eventData.goal.semanticAttributes.products.\$0.position                                           | int                                                                     | Product Position                                                                                                                                                                         | 1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Product Category ID                                                            | eventData.goal.semanticAttributes.products.\$0.categoryID                                         | string                                                                  | Product Category ID                                                                                                                                                                      | 30372425                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Product Category Name                                                          | eventData.goal.semanticAttributes.products.\$0.categoryName                                       | string                                                                  | Product Category Name                                                                                                                                                                    | Fashion > Shoes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Product Brand ID                                                               | eventData.goal.semanticAttributes.products.\$0.brandID                                            | string                                                                  | Product Brand ID                                                                                                                                                                         | 4499                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Product Brand Name                                                             | eventData.goal.semanticAttributes.products.\$0.brandName                                          | string                                                                  | Product Brand Name                                                                                                                                                                       | MyBrand                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Period                                                                         | eventData.goal.semanticAttributes.period                                                          | string                                                                  | Period (ISO 8601 duration format)<br />ex. P7D, P1M, P6M, P1Y                                                                                                                            | P1Y                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Is Renewal Event                                                               | eventData.goal.semanticAttributes.isRenewal                                                       | boolean                                                                 | Boolean type data to show whether the purchase is renweal or not                                                                                                                         | true                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Renewal Count                                                                  | eventData.goal.semanticAttributes.renewalCount                                                    | int                                                                     | Renewal Count                                                                                                                                                                            | 2                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Product List ID                                                                | eventData.goal.semanticAttributes.productListID                                                   | string                                                                  | Product List ID                                                                                                                                                                          | list-id-1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Cart ID                                                                        | eventData.goal.semanticAttributes.cartID                                                          | string                                                                  | Cart ID                                                                                                                                                                                  | cart-id-1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Transaction ID                                                                 | eventData.goal.semanticAttributes.transactionID                                                   | string                                                                  | Transaction ID                                                                                                                                                                           | 12939172                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Transaction Type                                                               | eventData.goal.semanticAttributes.transactionType                                                 | string                                                                  | Transaction Type<br />- cancel                                                                                                                                                           | cancel                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Transaction Paired Event Category                                              | eventData.goal.semanticAttributes.transactionPairedEventCategory                                  | string                                                                  | Transaction Paired Event Category                                                                                                                                                        | airbridge.ecommerce.order.completed                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Transaction Paired Event Timestamp                                             | eventData.goal.semanticAttributes.transactionPairedEventTimestamp                                 | int                                                                     | Transaction Paired Event Timestamp                                                                                                                                                       | 1599184266332                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Total Quantity                                                                 | eventData.goal.semanticAttributes.totalQuantity                                                   | int                                                                     | Total Quantity                                                                                                                                                                           | 5                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Search Query                                                                   | eventData.goal.semanticAttributes.query                                                           | string                                                                  | User's search query                                                                                                                                                                      | mybrand                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| In App Purchased                                                               | eventData.goal.semanticAttributes.inAppPurchased                                                  | boolean                                                                 | Boolean type data to show whether the purchase happened directly through the app or through an appstore purchase interface.<br />true: in-app purchase.<br />false: out-of-app purchase. | true                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Contribution Margin                                                            | eventData.goal.semanticAttributes.contributionMargin                                              | float                                                                   | Contribution Margin Revenue                                                                                                                                                              | 10000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Contribution Margin (Original)                                                 | eventData.goal.semanticAttributes.originalContributionMargin                                      | float                                                                   | Contribution margin from the original data                                                                                                                                               | 10000                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| List ID                                                                        | eventData.goal.semanticAttributes.listID                                                          | string                                                                  | List ID                                                                                                                                                                                  | 39420                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Rate ID                                                                        | eventData.goal.semanticAttributes.rateID                                                          | string                                                                  | Rate ID                                                                                                                                                                                  | 12939172                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Rate                                                                           | eventData.goal.semanticAttributes.rate                                                            | float                                                                   | Rate                                                                                                                                                                                     | 3                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Max Rate                                                                       | eventData.goal.semanticAttributes.maxRate                                                         | float                                                                   | Max Rate                                                                                                                                                                                 | 5.0                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Achievement ID                                                                 | eventData.goal.semanticAttributes.achievementID                                                   | string                                                                  | Achievement ID                                                                                                                                                                           | 12939172                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Shared Channel                                                                 | eventData.goal.semanticAttributes.sharedChannel                                                   | string                                                                  | Shared Channel                                                                                                                                                                           | facebook                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Date Time                                                                      | eventData.goal.semanticAttributes.datetime                                                        | string                                                                  | Date And Time (ISO-8601)                                                                                                                                                                 | 2022-08-11T01:31:07+00:00                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Description                                                                    | eventData.goal.semanticAttributes.description                                                     | string                                                                  | Description                                                                                                                                                                              | summer promotion                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Is Revenue Event                                                               | eventData.goal.semanticAttributes.isRevenue                                                       | boolean                                                                 | Boolean type data to show whether the event is related to revenue.<br />true: related to revenue.<br />false: not related to revenue.                                                    | true                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Place                                                                          | eventData.goal.semanticAttributes.place                                                           | string                                                                  | Place                                                                                                                                                                                    | Starbucks                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Schedule ID                                                                    | eventData.goal.semanticAttributes.scheduleID                                                      | string                                                                  | Schedule ID                                                                                                                                                                              | 1234                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Type                                                                           | eventData.goal.semanticAttributes.type                                                            | string                                                                  | Type                                                                                                                                                                                     | Credit Card                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Level                                                                          | eventData.goal.semanticAttributes.level                                                           | string                                                                  | Level                                                                                                                                                                                    | 4                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Score                                                                          | eventData.goal.semanticAttributes.score                                                           | float                                                                   | Score                                                                                                                                                                                    | 590                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Ad Revenue Meta Data                                                           | eventData.goal.semanticAttributes.adPartners                                                      | map                                                                     | Ad Revenue Meta Data                                                                                                                                                                     | \{<br />"mopub": \{<br />"app\_version": "5.18.0",<br />"adunit\_id": "12345",<br />"adunit\_name": "12345",<br />"adunit\_format": "Banner",<br />"id": "12345",<br />"currency": "USD",<br />"publisher\_revenue": 12345.123,<br />"adgroup\_id": "12345",<br />"adgroup\_name": "12345",<br />"adgroup\_type": "12345",<br />"adgroup\_priority": "12345",<br />"country": "kr",<br />"precision": "publisher\_defined",<br />"network\_name": "12345",<br />"network\_placement\_id": "12345",<br />"demand\_partner\_data": "12345"<br />}<br />} |
| Is First Event per User ID By Client                                           | eventData.goal.semanticAttributes.isFirstPerUser                                                  | boolean                                                                 | Boolean type data to show whether the event has happened in the past. (Set By Client)<br />- true: First Event.<br />- false: Not the First Event                                        | true                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

## Recommended Semantic Attributes

* [Recommended Semantic Attributes Sheet](https://docs.google.com/spreadsheets/d/e/2PACX-1vQgBzJwN3jnWEYCfaFOFmdabVjwhXQU9_L6U9ef053mm7OPJe6uFR2pWEhtKHCFrjBRrJIvsc2nlMbT/pubhtml?single=true\&gid=176781833\&widget=false\&chrome=false\&range=A1:F154)

<link rel="alternate" hrefLang="en" href="https://help.airbridge.io/en/developers/standard-events-and-semantic-attributes" />

<link rel="alternate" hrefLang="ko" href="https://help.airbridge.io/ko/developers/standard-events-and-semantic-attributes" />
