With the /report endpoint you have the ability to request many combinations of categories and metrics. However, please note: Combining different types of categories and metrics (e.g. SKU + action) can lead to unconventional aggregation results, and in some cases will result in an error (e.g. affiliate categories + analytics metrics, or analytics categories + affiliate metrics).
We strongly recommend pairing categories exclusively with the metrics that are of the same type or sub-type.
You can use General Categories with any other Categories, regardless of their type.
General Categories
Type | Sub-Type | Category | Supported Endpoints | Affluent UI Name | Field Description |
---|---|---|---|---|---|
general | - | accountId | any | N/A | Account Id |
general | - | accountName | any | Account | Account Name |
general | - | brandGroup | any | Brand Group | Brand Group |
general | - | brandId | any | Brand Id | Brand Id |
general | - | brandManagerName | any | Account Manager | Account Manager |
general | - | brandName | any | Brand | Brand Name |
general | - | brandVertical | any | Brand Vertical | Brand Vertical |
general | - | dayName | any | N/A | Day Name |
general | - | weekday | any | N/A | Day of the week (1-7) |
Affiliate Categories
Type | Sub-type | Category | Supported Endpoints | Affluent UI Name | Field Description |
---|---|---|---|---|---|
affiliate | sku | skuCategory | report | Category (sku) | Product Category |
affiliate | sku | skuCategoryParent | report | N/A | Parent Product Category |
affiliate | sku | skuCategoryParentTwo | report | N/A | Second Parent Product Category |
affiliate | sku | skuId | report | SKU | SKU |
affiliate | sku | skuName | report | Product Name | Product Name |
affiliate | action | actionId | any | N/A | Action ID |
affiliate | action | actionType | any | N/A | Action Type |
affiliate | action | affluentCreatedAt | any | N/A | Time data was recorded in Affluent |
affiliate | action | affluentId | any | N/A | Affluent Unique Id |
affiliate | action | affluentModifiedAt | action | N/A | Time data was modified in Affluent |
affiliate | action | brandCountry | any | N/A | Brand Country |
affiliate | action | brandId | any | Brand Id | Brand Id |
affiliate | action | brandGroup | any | Brand Group | Brand Group |
affiliate | action | brandManagerId | any | N/A | Account Manager Id |
affiliate | action | brandManagerName | any | Account Manager | Account Manager |
affiliate | action | brandName | any | Brand | Brand Name |
affiliate | action | brandTags | any | N/A | Brand Tags |
affiliate | action | brandVertical | any | Brand Vertical | Brand Vertical |
affiliate | action | browser | any | Browser | Browser |
affiliate | action | campaign | any | Campaign | Campaign Name |
affiliate | action | campaignId | any | Campaign Id | Campaign Id |
affiliate | action | checkInDate | any | Check-in Date | Check-in Date of the booking (commonly used by Hotel brands) |
affiliate | action | checkOutDate | any | Check-out Date | Check-out Date of the booking (commonly used by Hotel brands) |
affiliate | action | city | any | City | City |
affiliate | action | clickDatetime | action | N/A | Datetime of click |
affiliate | action | clickUnixTime | action | N/A | Unixtime of click |
affiliate | action | commissionType | any | Commission Type | Commission Type |
affiliate | action | country | any | country | Country |
affiliate | action | contryCode | any | N/A | Country Code |
affiliate | action | creative | any | Creative | Creative |
affiliate | action | creativeId | any | Creative Id | Creative Id |
affiliate | action | creativeType | any | Creative Type | Creative Type |
affiliate | action | crossDevice | any | Cross-Device | Cross Device |
affiliate | action | currency | any | Currency | Currency |
affiliate | action | customerId | any | Customer Id | Customer Id |
affiliate | action | details | any | Details/comment | Details/Comment |
affiliate | action | deviceModel | any | DeviceModel | Device Model |
affiliate | action | deviceType | any | Device Type | Device Type |
affiliate | action | district | any | District | District |
affiliate | action | eventCode | any | Event Code | Event Code |
affiliate | action | eventTypeId | any | N/A | Event Type Id |
affiliate | action | eventTypeName | any | N/A | Event Type Name |
affiliaet | action | landingPage | any | Landing Page | Landing Page |
affiliate | action | merchantId | any | Brand Id | Brand Id |
affiliate | action | newToFile | any | N/A | New to File customer |
affiliate | action | orderId | any | N/A | Order Id |
affiliate | action | os | any | Operating System | Operating System |
affiliate | action | platformName | any | Platform | Platform Name |
affiliate | action | networkId | any | N/A | Network Id |
affiliate | action | postCode | any | Post Code | Post Code |
affiliate | action | promoCode | any | Promo Code | Promo Code |
affiliate | action | publisherCountry | any | Publisher Country | Publisher Country |
affiliate | action | publisherEmail | any | Publisher Email | Publisher Email |
affiliate | action | publisherGroup | any | Publisher Group | Publisher Group |
affiliate | action | publisherId | any | Publisher Id | Publisher Id |
affiliate | action | publisherName | any | Publisher | Publisher Name |
affiliate | action | publisherNameMerged | any* *you can only filter by publisherNameMerged with the /action endpoint | Publisher | Merged Publisher Name |
affiliate | action | publisherPrimaryWebsite | any | N/A | Publisher Primary Website |
affiliate | action | publisherTags | any | Publisher Tags | Publisher Tags |
affiliate | action | publisherTermsId | any | N/A | Publisher IO/Contract Id |
affiliate | action | publisherTermsGroupId | any | N/A | Publisher IO/Contract Group Id |
affiliate | action | publisherTermsName | any | Offer/Insertion Order | Publisher IO/Contract Name |
affiliate | action | publisherType | any | Publisher Type | Publisher Type |
affiliate | action | publisherJoinDate | any | N/A | Date the publisher joined the Brand |
affiliate | action | publisherWebsiteId | any | Website Id | Publisher Website Id |
affiliate | action | publisherWebsiteName | any | Website | Publisher Website Name |
affiliate | action | publisherWebsiteUrl | any | N/A | Publisher Website Url |
affiliate | action | referralDomain | any | Referral Domain | Referral Domain |
affiliate | action | referralURL | any | Referral Url | Referral Url |
affiliate | action | repeatCustomer | any | N/A | Repeat Customer |
affiliate | action | sharedId | any | Shared Id | Shared Id |
affiliate | action | skuAffluentCreatedAt | any | N/A | Time SKU was recorded in Affluent |
affiliate | action | skuAffluentModifiedAt | any | N/A | Time SKU was modified in Affluent |
affiliate | action | status | any | Status | Action Status |
affiliate | action | subaffiliate | any | Subaffiliate | Subaffiliate Publisher |
affiliate | action | subid1 | any | N/A | sub Id 1 |
affiliate | action | unixTime | action | N/A | Unixtime |
affiliate | action | customField1 | any | Custom Field 1 | Impact: Text1 |
affiliate | action | customField2 | any | Custom Field 2 | Impact: Text2 |
affiliate | action | customField3 | any | Custom Field 3 | Impact: Text3 |
affiliate | action | customField4 | any | Custom Field 4 | Impact: Numeric1 |
affiliate | action | customField5 | any | Custom Field 5 | Impact: Numeric2 |
affiliate | action | customField6 | any | Custom Field 6 | Impact: Numeric3 |
affiliate | action | customField7 | any | Custom Field 7 | Impact: Adv Money1 |
affiliate | action | customField8 | any | Custom Field 8 | Impact: Adv Money2 |
affiliate | action | customField9 | any | Custom Field 9 | Impact: Adv Money3 |
affiliate | action | customField10 | any | Custom Field 10 | Impact: MP Value 1 |
affiliate | action | customField11 | any | Custom Field 11 | Impact: MP Value 2 |
affiliate | action | customField12 | any | Custom Field 12 | Impact: MP Value 3 |
affiliate | action | customField13 | any | Custom Field 13 | Impact: Disposition |
affiliate | action | customField14 | any | Custom Field 14 | Impact: Adv Date1 |
affiliate | action | customField15 | any | Custom Field 15 | Impact: Adv Date2 |
affiliate | action | customField16 | any | Custom Field 16 | Impact: Adv Date3 |
affiliate | action | customField17 | any | Custom Field 17 | Impact: Referral Param1 |
affiliate | action | customField18 | any | Custom Field 18 | Impact: Referral Param2 |
affiliate | action | customField19 | any | Custom Field 19 | Impact: Referral Param3 |
affiliate | action | customField20 | any | Custom Field 20 | Impact: Referral Param4 |
Analytics Categories*
Type | Sub-type | Category | Supported Endpoints | Affluent UI Name |
---|---|---|---|---|
analytics | session, transacton, sku | analyticsAdContent | report | Ad Content |
analytics | session, transacton | analyticsAdGroup | report | Ad Group |
analytics | session, transacton | analyticsAdSlot | report | Ad Slot |
analytics | session, transacton | analyticsAdTargetingType | report | Ad Targeting Type |
analytics | transacton, sku | analyticsAffiliation | report | Affiliation |
analytics | session, transacton, sku | analyticsBrowser | report | Browser |
analytics | session, transacton, sku | analyticsBrowserSize | report | Browser Size |
analytics | session, transacton | analyticsBrowserVersion | report | Browser Version |
analytics | session, transacton, sku | analyticsCampaign | report | Campaign |
analytics | transaction | analyticsCheckoutOptions | report | Checkout Options |
analytics | session, transacton | analyticsCity | report | City |
analytics | session, transacton | analyticsContinent | report | Continent |
analytics | session, transacton | analyticsContinentId | report | Continent Id |
analytics | session, transacton, sku | country | report | Country |
analytics | session, transacton, sku | analyticsCustomDimension1 | report | Custom Dimension 1 |
analytics | session | analyticsCustomDimension2 | report | Custom Dimension 2 |
analytics | session | analyticsCustomDimension3 | report | Custom Dimension 3 |
analytics | session | analyticsCustomDimension4 | report | Custom Dimension 4 |
analytics | session | analyticsCustomDimension5 | report | Custom Dimension 5 |
analytics | session | analyticsCustomDimension6 | report | Custom Dimension 6 |
analytics | session | analyticsCustomDimension7 | report | Custom Dimension 7 |
analytics | session | analyticsCustomDimension8 | report | Custom Dimension 8 |
analytics | session, transaction | analyticsDataSource | report | Data Source |
analytics | session, transaction | analyticsDatetime | report | Datetime |
analytics | session, transaction | analyticsDeviceCategory | report | Device Category |
analytics | session, transaction | analyticsExitPagePath | report | Exit Page Path |
analytics | session, transaction, sky | analyticsHostname | report | Hostname |
analytics | session, transaction, sku | analyticsKeyword | report | Keyword |
analytics | session, transaction, sku | analyticsLandingPagePath | report | Landing Page Path |
analytics | session, transaction, sku | analyticsMedium | report | Medium |
analytics | session, transaction | analyticsMetro | report | Metro |
analytics | session, transaction, sku | analyticsMobileDeviceBranding | report | Mobile Device Branding |
analytics | session, transaction | analyticsMobileDeviceModel | report | Mobile Device Model |
analytics | session, transaction | analyticsNetworkDomain | report | Network Domain |
analytics | session, transaction | analyticsNetworkLocation | report | Network Location |
analytics | session, transaction, sku | analyticsOperatingSystem | report | Operating System |
analytics | session, transaction, sku | analyticsOperatingSystemVersion | report | Operating System Version |
analytics | transaction | analyticsOrderCouponCode | report | Order Coupon Code |
analytics | session, transaction | analyticsPageDepth | report | Page Depth |
analytics | session, transaction, sku | analyticsPagePath | report | Page Path |
analytics | session | analyticsPageTitle | report | Page Title |
analytics | session, transaction | analyticsReferralDomain | report | Referral Domain |
analytics | session, transaction, sku | analyticsReferralUrl | report | Referral Url |
analytics | session, transaction | analyticsRegion | report | Region |
analytics | session, transaction | analyticsSegment | report | Segment |
analytics | transaction | analyticsShoppingStage | report | Shopping Stage |
analytics | session, transaction, sku | analyticsSource | report | Source |
analytics | session, transaction | analyticsSubContinent | report | Sub Continent |
analytics | transaction, sku | analyticsTransactionId | report | Transaction Id |
analytics | session, transaction, sku | analyticsUserType | report | User Type |
analytics | session, transaction, sku | analyticsEventName | report | Event Name |
analytics | sku | analyticsItemBrand | report | Item Brand |
analytics | sku | analyticsItemCategory | report | Item Category |
analytics | sku | analyticsItemId | report | Item Id |
analytics | sku | analyticsItemListName | report | Item List Name |
analytics | sku | analyticsItemName | report | Item Name |
analytics | session, transaction, sku | analyticsPercentScrolled | report | Percent Scrolled |
analytics | session, transaction, sku | analyticsSearchTerm | report | Search Term |
analytics | session, transaction, sku | analyticsUserAgeBracket | report | User Age Bracket |
analytics | session, transaction, sku | analyticsUserGender | report | User Gender |
analytics | session, transaction, sku | analyticsViewId | report | View ID |
analytics | session, transaction, sku | analyticsViewName | report | View Name |
*For a more detailed descriptions of all the Google Analytic categories please see here.
For the /actions endpoint:
- For all categories beginning
sku
add"includeSkus": true
to your query. - For all categories beginning
customField
add"includeCustomFields": true
to your query.