--- updatedAt: 2025-04-30T20:34:45.000Z agentTools: projectIndex: https://docs.affluent.io/llms.txt --- # Actions Endpoint note: The {yourAgencyName} placeholder should be substituted with the subdomain of the URL you use to access the Affluent dashboard. For instance, if you log in at “dundermifflin.affluent.io” then you should replace {yourAgencyName} with “dundermifflin” The actions endpoint allows you to pull a list of every unique commissionable action (e.g. sales, leads, bonuses, etc) with all associated data Affluent has on that transaction, including SKU data. Importantly, if you're maintaining your own data store, this API allows you to pull actions based on the last time they were **modified** so that you do not need to perform historical data pulls in order to update pending transactions. The JSON body requires: 1. A ```dates``` object that specifies the date range for which you would like to query data. Dates are requested in **UTC** time and the **date range you specify can not be larger than 62 days**, so please bear that in mind. There are two accepted date types: - Use ```eventDateStart``` and ```eventDateEnd``` to request actions which occurred in that range. This should use dates. For example: ```json "dates": { "eventDateStart": "2023-09-19", "eventDateEnd": "2023-09-22" } ``` - **RECOMMENDED FOR DATA STORES**: Use ```affluentModifiedAtStart``` and ```affluentModifiedAtEnd``` to request actions based on a last modified date. This should use datetimes. For example: ```json "dates": { "affluentModifiedAtStart": "2023-09-21T00:00:00+01:00", "affluentModifiedAtEnd": "2023-09-22T00:00:00+01:00" } ``` 2. A ```limit``` and ```offset``` (see Limit and Offset) 3. An ```includeCustomFields``` flag The JSON body can additionally accept: 1. Filters. Full description can be found here. For example: ```json "filters": { "operator": "AND", "statements": [ { "category": "brandName", "match": "equals", "values": "Evil Corp" }, { "category": "publisherName", "match": "notEquals", "values": "Evil Product Reviews" } ] } ``` 2. An SKU flag (optional) to include or exclude SKU data. The default is false. For example: ```json "includeSkus": true ``` **Best Practices:** * Use a limit of 100,000. # OpenAPI definition ````json { "openapi": "3.1.0", "info": { "title": "Endpoint Reference", "description": "Agency API documentation", "version": "1.10.95" }, "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "name": "apiKey", "in": "query" } } }, "paths": { "/v1/actions/": { "post": { "summary": "Actions Endpoint", "tags": [ "action" ], "description": "note: The {yourAgencyName} placeholder should be substituted with the subdomain of the URL you use to access the Affluent dashboard. For instance, if you log in at “dundermifflin.affluent.io” then you should replace {yourAgencyName} with “dundermifflin”\n\nThe actions endpoint allows you to pull a list of every unique commissionable action (e.g. sales, leads, bonuses, etc) with all associated data Affluent has on that transaction, including SKU data. Importantly, if you're maintaining your own data store, this API allows you to pull actions based on the last time they were **modified** so that you do not need to perform historical data pulls in order to update pending transactions.\n\nThe JSON body requires:\n\n1. A ```dates``` object that specifies the date range for which you would like to query data. Dates are requested in **UTC** time and the **date range you specify can not be larger than 62 days**, so please bear that in mind. There are two accepted date types:\n - Use ```eventDateStart``` and ```eventDateEnd``` to request actions which occurred in that range. This should use dates. For example:\n```json\n\"dates\":\n{\n \"eventDateStart\": \"2023-09-19\",\n \"eventDateEnd\": \"2023-09-22\"\n}\n```\n - **RECOMMENDED FOR DATA STORES**: Use ```affluentModifiedAtStart``` and ```affluentModifiedAtEnd``` to request actions based on a last modified date. This should use datetimes. For example:\n```json\n\"dates\":\n{\n \"affluentModifiedAtStart\": \"2023-09-21T00:00:00+01:00\",\n \"affluentModifiedAtEnd\": \"2023-09-22T00:00:00+01:00\"\n}\n```\n2. A ```limit``` and ```offset``` (see Limit and Offset)\n3. An ```includeCustomFields``` flag\n\nThe JSON body can additionally accept:\n\n1. Filters. Full description can be found here. For example:\n```json\n\"filters\": {\n \"operator\": \"AND\",\n \"statements\": [\n {\n \"category\": \"brandName\",\n \"match\": \"equals\",\n \"values\": \"Evil Corp\"\n },\n {\n \"category\": \"publisherName\",\n \"match\": \"notEquals\",\n \"values\": \"Evil Product Reviews\"\n }\n ]\n}\n```\n\n2. An SKU flag (optional) to include or exclude SKU data. The default is false. For example:\n\n```json\n\"includeSkus\": true\n```", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "currency": { "type": "string", "title": "Currency to convert results to", "enum": [ "AED", "AUD", "BGN", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "JPY", "KRW", "KZT", "MXN", "MYR", "NGN", "NOK", "NZD", "PEN", "PHP", "PKR", "PLN", "QAR", "RMB", "RON", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "TZS", "USD", "VND", "ZAR" ] }, "dates": { "type": "object", "title": "Date range", "oneOf": [ { "type": "object", "title": "Date range with a single period", "additionalProperties": false, "required": [ "eventDateStart", "eventDateEnd" ], "properties": { "eventDateStart": { "type": "string", "format": "date" }, "eventDateEnd": { "type": "string", "format": "date" } } }, { "type": "object", "title": "Date range with a single period", "description": "Get data based on the date field was last modified", "additionalProperties": false, "required": [ "affluentModifiedAtStart", "affluentModifiedAtEnd" ], "properties": { "affluentModifiedAtStart": { "anyOf": [ { "type": "string", "format": "date-time", "description": "ISO 8601 date (timezone required!)" }, { "type": "string", "format": "date", "description": "ISO Date. NOTE: This format is deprecated and will soon be removed. Please use 'date-time' format" } ] }, "affluentModifiedAtEnd": { "anyOf": [ { "type": "string", "format": "date-time", "description": "ISO 8601 date (timezone required!)" }, { "type": "string", "format": "date", "description": "ISO Date. NOTE: This format is deprecated and will soon be removed. Please use 'date-time' format" } ] } } }, { "title": "Date range with multiple periods", "additionalProperties": false, "required": [ "mainPeriod", "dateComparison" ], "properties": { "mainPeriod": { "type": "object", "additionalProperties": false, "title": "Main date range", "required": [ "eventDateStart", "eventDateEnd" ], "properties": { "eventDateStart": { "type": "string", "format": "date" }, "eventDateEnd": { "type": "string", "format": "date" } } }, "dateComparison": { "type": "object", "additionalProperties": false, "title": "Date comparison date range", "required": [ "eventDateStart", "eventDateEnd" ], "properties": { "eventDateStart": { "type": "string", "format": "date" }, "eventDateEnd": { "type": "string", "format": "date" } } } } } ] }, "firstDayOfWeek": { "type": "integer", "default": 1, "minimum": 1, "maximum": 7, "title": "First day of week", "description": "Specify first day of week: 1 (Monday) - 7 (Sunday)" }, "limit": { "type": "integer", "title": "Number of rows in response", "default": 100, "minimum": 1, "maximum": 100000 }, "offset": { "type": "integer", "title": "Offset of the results", "description": "Can be used for pagination in combination with 'limit'", "minimum": 0, "default": 0 }, "filters": { "type": "object", "additionalProperties": false, "title": "Filter out results by categories", "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ] }, "statements": { "type": "array", "uniqueItems": true, "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "actionId", "actionSkus", "actionSkusWithCurrency", "actionType", "affluentCreatedAt", "affluentId", "affluentModifiedAt", "maxActionModifiedAt", "maxTrafficModifiedAt", "maxSkuModifiedAt", "browser", "campaign", "campaignId", "city", "clickDatetime", "clickUnixTime", "commissionType", "convertedCurrency", "country", "countryCode", "creative", "creativeId", "creativeType", "crossDevice", "currency", "details", "deviceModel", "deviceType", "district", "eventCode", "eventTypeId", "eventTypeName", "landingPage", "merchantId", "newToFile", "orderId", "os", "platformName", "networkId", "postCode", "postingDate", "promoCode", "referralDomain", "referralURL", "repeatCustomer", "subaffiliate", "sharedId", "status", "skuAffluentCreatedAt", "skuAffluentModifiedAt", "unixTime", "customField1", "customField2", "customField3", "customField4", "customField5", "customField6", "customField7", "customField8", "customField9", "customField10", "customField11", "customField12", "customField13", "customField14", "customField15", "customField16", "customField17", "customField18", "customField19", "customField20", "customField21", "customField22", "customField23", "customField24", "customField25", "customField26", "customField27", "customField28", "customField29", "customField30", "customerId", "checkInDate", "checkOutDate", "skuCategory", "skuCategoryParent", "skuCategoryParentTwo", "skuId", "skuName", "skuCatalogCategory", "skuCatalogSubCategory", "skuBrandName", "eventId", "eventName", "eventSource", "eventType", "eventSubType", "eventStartDate", "eventEndDate", "eventAccountManager", "eventFeeType", "eventFeeIncreaseType", "eventCurrency", "eventPromotion", "eventSeasonalEvent", "eventDescription", "eventNotes", "eventTags", "eventImage", "eventAdditionalClassification", "eventPaidInNetwork", "eventDatePaid", "analyticsAdContent", "analyticsAdGroup", "analyticsAdSlot", "analyticsAdTargetingType", "analyticsAffiliation", "analyticsBrowser", "analyticsBrowserSize", "analyticsBrowserVersion", "analyticsCampaign", "analyticsCheckoutOptions", "analyticsCity", "analyticsContinent", "analyticsContinentId", "analyticsCustomDimension1", "analyticsCustomDimension2", "analyticsCustomDimension3", "analyticsCustomDimension4", "analyticsCustomDimension5", "analyticsCustomDimension6", "analyticsCustomDimension7", "analyticsCustomDimension8", "analyticsDataSource", "analyticsDatetime", "analyticsDeviceCategory", "analyticsExitPagePath", "analyticsHostname", "analyticsId", "analyticsKeyword", "analyticsLandingPagePath", "analyticsMedium", "analyticsMetro", "analyticsMobileDeviceBranding", "analyticsMobileDeviceModel", "analyticsNetworkDomain", "analyticsNetworkLocation", "analyticsOperatingSystem", "analyticsOperatingSystemVersion", "analyticsOrderCouponCode", "analyticsPageDepth", "analyticsPagePath", "analyticsPageTitle", "analyticsPrimaryChannelGroup", "analyticsReferralDomain", "analyticsReferralUrl", "analyticsRegion", "analyticsSegment", "analyticsShoppingStage", "analyticsSource", "analyticsSubContinent", "analyticsTransactionId", "analyticsUserType", "analyticsEventName", "analyticsItemBrand", "analyticsItemCategory", "analyticsItemId", "analyticsItemListName", "analyticsItemName", "analyticsPercentScrolled", "analyticsSearchTerm", "analyticsUserAgeBracket", "analyticsUserGender", "analyticsViewId", "analyticsViewName", "analyticsCountry", "adGroupName", "adGroupStatus", "adStrength", "adGroupId", "adPerformanceDate", "adCampaignId", "adKeywordMatchType", "adKeyword", "adDisplayUrl", "adId", "adName", "adTextAdDescription", "adTextAdHeadline", "adStatus", "adDynamicSearchAdDescription", "adExpandedTextAdDescription", "adExpandedTextAdHeadline", "adAccountId", "adCurrencyCode", "adBiddingStrategy", "adBiddingStrategyType", "adOptimizationStatus", "adChannelSubType", "adChannelType", "adAppStore", "adAppId", "adDisplayUploadType", "adResponsiveDisplayHeadline", "adResponsiveSearchAdPath", "adCampaign", "accountId", "accountName", "date", "dateTime", "dayName", "endOfWeek", "fiscalPeriodIndex", "periodJoinDate", "periodJoinEndOfWeek", "periodJoinEndOfMonth", "periodJoinEndOfMonthFiscal", "periodJoinStartOfMonth", "periodJoinStartOfMonthFiscal", "periodJoinStartOfWeek", "periodJoinEndOfYear", "periodJoinEndOfYearFiscal", "periodJoinStartOfYear", "periodJoinStartOfYearFiscal", "startOfMonth", "startOfMonthFiscal", "endOfMonth", "ipAddress", "startOfWeek", "weekOfYear", "weekday", "year", "startOfYear", "startOfYearFiscal", "endOfYear", "odysseyMedium", "odysseySource", "publisherMatchType", "publisherMatchId", "publisherMatchGaId", "publisherMatchGaName", "isPublisherMatchActive", "publisherPrimaryContactName", "publisherSecondaryContactName", "publisherTertiaryContactName", "publisherPrimaryContactEmail", "publisherSecondaryContactEmail", "publisherTertiaryContactEmail", "brandPrimaryContactName", "brandSecondaryContactName", "brandTertiaryContactName", "brandPrimaryContactEmail", "brandSecondaryContactEmail", "brandTertiaryContactEmail", "platformPrimaryContactName", "platformSecondaryContactName", "platformTertiaryContactName", "platformPrimaryContactEmail", "platformSecondaryContactEmail", "platformTertiaryContactEmail", "creatorId", "creatorName", "creatorCampaignId", "creatorCampaignName", "creatorCreationDate", "creatorEventDate", "creatorPostId", "creatorPostName", "creatorPostUrl", "creatorPostType", "creatorTaskContentType", "creatorSocialPlatform", "brandGroup", "brandWebsite", "brandId", "brandCustomerId", "brandName", "brandManagerName", "brandManagerId", "brandTags", "brandVertical", "brandVerticalId", "publisherCountry", "publisherGroup", "publisherGroup2", "publisherGroup3", "publisherEmail", "publisherId", "publisherNameMerged", "publisherNameUnmerged", "publisherPrimaryWebsite", "publisherTags", "publisherTermsId", "publisherTermsGroupId", "publisherTermsName", "publisherType", "publisherJoinDate", "hasPublisherRecruitment", "publisherWebsiteId", "publisherWebsiteName", "publisherWebsiteNameOrUrl", "publisherWebsiteUrl", "publisherName", "isMergedPublisher", "publisherIdMerged" ] }, "match": { "type": "string", "enum": [ "equals", "like", "likeCaseSensitive", "arrayIncludes", "notArrayIncludes", "likeAny", "likeAnyCaseSensitive", "regexp", "notLike", "isNull", "isNotNull", "nullOrEmpty", "notNullOrEmpty", "notLikeCaseSensitive", "notLikeAny", "notLikeAnyCaseSensitive", "notEquals", "notRegexp" ] }, "values": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "array", "uniqueItems": true, "items": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } } ] } } } } } }, "having": { "type": "object", "title": "Filter out results by metric value", "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ] }, "statements": { "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "analyticsBounces", "analyticsConversions", "analyticsCustomMetric1", "analyticsCustomMetric10", "analyticsCustomMetric2", "analyticsCustomMetric3", "analyticsCustomMetric4", "analyticsCustomMetric5", "analyticsCustomMetric6", "analyticsCustomMetric7", "analyticsCustomMetric8", "analyticsCustomMetric9", "analyticsDaysToTransaction", "analyticsEntrances", "analyticsEventValue", "analyticsEvents", "analyticsExits", "analyticsGoalCompletionsAll", "analyticsGoalStartsAll", "analyticsGoalValueAll", "analyticsHits", "analyticsInternalPromotionClicks", "analyticsInternalPromotionViews", "analyticsItemQuantity", "analyticsItemRevenue", "analyticsItemsCheckedOut", "analyticsNewUsers", "analyticsPageviews", "analyticsProductAddsToCart", "analyticsProductCheckouts", "analyticsProductDetailViews", "analyticsProductListClicks", "analyticsProductListViews", "analyticsProductRefundAmount", "analyticsProductRefunds", "analyticsProductRemovesFromCart", "analyticsQuantityAddedToCart", "analyticsQuantityCheckedOut", "analyticsQuantityRefunded", "analyticsQuantityRemovedFromCart", "analyticsRefundAmount", "analyticsSessionDuration", "analyticsSessions", "analyticsSessionsToTransaction", "analyticsTimeOnPage", "analyticsTotalRefunds", "analyticsTransactionRevenue", "analyticsTransactionShipping", "analyticsTransactionTax", "analyticsTransactions", "analyticsUniquePurchases", "adTargetCPM", "adClicks", "adImpressions", "adAvgPageViews", "adAvgTimeOnSite", "adBounceRate", "adTotalConversions", "adConversions", "adTotalConversionsValue", "adConversionsValue", "adCost", "adCostPerConversion", "adCrossDeviceConversions", "adClickThroughRate", "adEngagementRate", "adEngagements", "adInteractionRate", "adInteractions", "adPercentNewVisitors", "adValuePerConversions", "adVideoViewRate", "adVideoViews", "adViewThroughConversions", "adGmailForwards", "adGmailSaves", "adGmailSecondaryClicks", "adTopImpressionPercentage", "adVideoViewRate100", "adVideoViewRate75", "adVideoViewRate50", "adVideoViewRate25", "adAbsoluteTopImpressionPercentage", "adActiveViewCPM", "adActiveViewImpressions", "adActiveViewMeasurableCost", "adActiveViewMeasurableImpressions", "adLandingPageViews", "adLinkClick", "adOnsiteConversionPostSave", "adPostReaction", "adPostEngagement", "adPageEngagement", "adInlineLinkClicks", "adInlinePostEngagement", "adOutboundClicks", "adInlineLinkClickCTR", "adReach", "nonCommissionableClickCount", "rawClickCount", "clickthroughRate", "impressionCount", "agencyFee", "averageItemValueNet", "skuAdvertiserRevenueApproved", "skuAdvertiserRevenueDisputed", "skuAdvertiserRevenueGross", "skuAdvertiserRevenueNet", "skuAdvertiserRevenuePending", "skuPublisherCommissionApproved", "skuPublisherCommissionDisputed", "skuPublisherCommissionGross", "skuPublisherCommissionNet", "skuPublisherCommissionPending", "skuQuantity", "skuQuantityApproved", "skuQuantityDisputed", "skuQuantityGross", "skuQuantityNet", "skuQuantityPending", "skuTotalCommission", "skuTotalPrice", "skuUnitCommission", "skuUnitPrice", "actionCountApproved", "actionCountDisputed", "actionCountGross", "actionCountNet", "actionCountPending", "advertiserRevenue", "advertiserRevenueApproved", "advertiserRevenueDisputed", "advertiserRevenueGross", "advertiserRevenueNet", "advertiserRevenuePending", "advertiserRevenueRefunded", "advertiserRevenueRejected", "agencyCommissionApproved", "agencyCommissionDisputed", "agencyCommissionGross", "agencyCommissionNet", "agencyCommissionPending", "agencyCommissionRefunded", "agencyCommissionRejected", "averageLeadValueNet", "averageOrderValueNet", "bonusAmountApproved", "bonusAmountDisputed", "bonusAmountGross", "bonusAmountNet", "bonusAmountPending", "bonusAmountRejected", "bonusNetworkFeeApproved", "bonusNetworkFeeDisputed", "bonusNetworkFeeGross", "bonusNetworkFeeNet", "bonusNetworkFeePending", "bonusNetworkFeeRejected", "bonusCountApproved", "bonusCountDisputed", "bonusCountGross", "bonusCountNet", "bonusCountPending", "bonusCountRejected", "commissionableClickCountNet", "costToRevenueNet", "cpaNet", "cplNet", "discount", "leadAdvertiserRevenueNet", "leadCountApproved", "leadCountDisputed", "leadCountGross", "leadCountNet", "leadCountPending", "networkFee", "networkFeeApproved", "networkFeeDisputed", "networkFeeGross", "networkFeeNet", "networkFeePending", "placementFeeNet", "publisherCommission", "publisherCommissionApproved", "publisherCommissionDisputed", "publisherCommissionGross", "publisherCommissionNet", "publisherCommissionPending", "publisherCommissionExcBonusApproved", "publisherCommissionExcBonusDisputed", "publisherCommissionExcBonusGross", "publisherCommissionExcBonusNet", "publisherCommissionExcBonusPending", "roasNet", "saleAdvertiserRevenueNet", "saleCountApproved", "saleCountDisputed", "saleCountGross", "saleCountNet", "saleCountPending", "totalCommissionApproved", "totalCommissionDisputed", "totalCommissionGross", "totalCommissionNet", "totalCommissionRejected", "totalCommissionPending", "totalProfitNet", "totalSpendApproved", "totalSpendDisputed", "totalSpendGross", "totalSpendNet", "totalSpendRejected", "totalSpendPending", "twoTierBountyCountNet", "nightsStayed", "roomCount", "clickCount", "crNet", "epcNet", "leadConversionRateNet", "activePublisherCount", "productivePublisherCount", "newPublisherCount", "totalPublisherCount", "inactivePublisherCount", "advertiserRevenuePerPublisherProductive", "advertiserRevenuePerPublisherActive", "advertiserRevenuePerPublisherJoined", "customerCountTotal", "customerCountNew", "customerCountPaid", "customerCountAcquired", "odysseyIncrementality", "odysseyTransactions", "odysseyCost", "odysseySuggestedCommission", "odysseyPosition", "odysseyParticipatedRevenue", "odysseyAttributedRevenue", "odysseyAOV", "odysseySession", "odysseyClickCount", "odysseyBounces", "odysseyNumberOfDays", "odysseyNumberOfClicks", "odysseyNewUsers", "eventFeeFixed", "eventFeeCommissionIncrease", "eventClicks", "eventOrdersNet", "eventOrdersGross", "eventOrdersDisputed", "eventRevenueNet", "eventRevenueGross", "eventRevenueDisputed", "eventNetworkCommissionNet", "eventNetworkCommissionGross", "eventNetworkCommissionDisputed", "eventPublisherCommissionNet", "eventPublisherCommissionGross", "eventPublisherCommissionDisputed", "eventAov", "eventRoas", "eventTotalSpendNet", "eventTotalSpendGross", "eventTotalPublisherSpendNet", "eventTotalPublisherSpendGross", "eventOrdersNetNewCustomers", "eventOrdersGrossNewCustomers", "eventRevenueNetNewCustomers", "eventRevenueGrossNewCustomers", "eventPublisherCommissionNetNewCustomers", "eventPublisherCommissionGrossNewCustomers", "eventAovNewCustomers", "eventRoasNewCustomers", "eventTotalSpendNetNewCustomers", "eventTotalSpendGrossNewCustomers", "eventTotalPublisherSpendNetNewCustomers", "eventTotalPublisherSpendGrossNewCustomers", "eventOrdersNetExistingCustomers", "eventOrdersGrossExistingCustomers", "eventRevenueNetExistingCustomers", "eventRevenueGrossExistingCustomers", "eventPublisherCommissionNetExistingCustomers", "eventPublisherCommissionGrossExistingCustomers", "eventAovExistingCustomers", "eventRoasExistingCustomers", "eventTotalSpendNetExistingCustomers", "eventTotalSpendGrossExistingCustomers", "eventTotalPublisherSpendNetExistingCustomers", "eventTotalPublisherSpendGrossExistingCustomers", "publisherMatchRating", "creatorEngagementCount", "creatorImpressionCount", "creatorPostCount", "creatorLikeCount", "creatorCommentCount", "creatorShareCount", "creatorReachCount", "creatorFollowerCount", "creatorViewCount", "creatorClickCount", "creatorActionCount", "creatorPublisherCommission", "creatorBonusCost", "creatorFlatFee", "creatorTotalSpend", "creatorAdvertiserRevenue", "creatorConversionRate", "creatorRoas", "commission", "uniquePublisherCount" ] }, "match": { "type": "string", "enum": [ "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual" ] }, "value": { "type": "number" } } } } } }, "useExperimentalPagination": { "type": "boolean", "title": "Use experimental pagination", "description": "If set to true the new experimental pagination logic will be used.\nThat should speed up pagination when dealing with huge results.", "default": false }, "includeSkus": { "type": "boolean", "default": false }, "includeCustomFields": { "type": "boolean", "default": false } } } } } }, "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "Default Response", "content": { "application/stream+json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "account", "affluentCreatedAt", "affluentId", "affluentModifiedAt", "amounts", "brand", "campaign", "clickDatetime", "clickUnixTime", "creative", "currency", "dateTime", "details", "eventCode", "eventTypeId", "eventTypeName", "id", "landingPage", "orderId", "promoCode", "publisher", "referralDomain", "referralUrl", "status", "type", "unixTime", "user" ], "properties": { "account": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "platformName" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "platformName": { "type": "string" } } }, "affluentCreatedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{3}$" }, "affluentId": { "type": "integer" }, "affluentModifiedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{3}$" }, "amounts": { "type": "object", "additionalProperties": false, "required": [ "advertiserRevenue", "advertiserRevenueDisputed", "count", "networkFee", "networkFeeDisputed", "publisherCommission", "publisherCommissionDisputed" ], "properties": { "advertiserRevenue": { "type": "number", "multipleOf": 0.01 }, "advertiserRevenueDisputed": { "type": "number", "multipleOf": 0.01 }, "count": { "type": "integer" }, "networkFee": { "type": "number", "multipleOf": 0.01 }, "networkFeeDisputed": { "type": "number", "multipleOf": 0.01 }, "publisherCommission": { "type": "number", "multipleOf": 0.01 }, "publisherCommissionDisputed": { "type": "number", "multipleOf": 0.01 } } }, "brand": { "type": "object", "additionalProperties": false, "required": [ "group", "id", "managerName", "name", "vertical" ], "properties": { "group": { "type": "string", "nullable": true }, "id": { "type": "integer" }, "managerName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "vertical": { "type": "string", "nullable": true } } }, "campaign": { "type": "object", "additionalProperties": false, "required": [ "id", "name" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "clickDatetime": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{3}$" }, "clickUnixTime": { "type": "integer" }, "creative": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "type" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "nullable": true } } }, "currency": { "type": "string" }, "dateTime": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{3}$" }, "details": { "type": "string" }, "eventCode": { "type": "string", "nullable": true }, "eventTypeId": { "type": "string", "nullable": true }, "eventTypeName": { "type": "string", "nullable": true }, "id": { "type": "string" }, "landingPage": { "type": "string", "format": "uri" }, "orderId": { "type": "string" }, "promoCode": { "type": "string", "nullable": true }, "publisher": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "tag", "termsId", "termsName", "type", "websiteId", "websiteName" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "tag": { "type": "string", "nullable": true }, "termsId": { "type": "string" }, "termsName": { "type": "string" }, "type": { "type": "string", "nullable": true }, "websiteId": { "type": "string" }, "websiteName": { "type": "string", "nullable": true } } }, "referralDomain": { "type": "string", "format": "uri", "nullable": true }, "referralUrl": { "type": "string", "format": "uri", "nullable": true }, "skus": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "affluentCreatedAt", "affluentModifiedAt", "category", "categoryParent", "categoryParentTwo", "id", "name", "quantity", "totalCommission", "totalPrice", "unitCommission", "unitPrice" ], "properties": { "affluentCreatedAt": { "type": "string", "format": "datetime" }, "affluentModifiedAt": { "type": "string", "format": "datetime" }, "category": { "type": "string", "nullable": true }, "categoryParent": { "type": "string", "nullable": true }, "categoryParentTwo": { "type": "string", "nullable": true }, "id": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "integer", "minimum": 1 }, "totalCommission": { "type": "number", "multipleOf": 0.01 }, "totalPrice": { "type": "number", "multipleOf": 0.01 }, "unitCommission": { "type": "number", "multipleOf": 0.01 }, "unitPrice": { "type": "number", "multipleOf": 0.01 } } } }, "status": { "type": "string", "nullable": true }, "type": { "type": "string" }, "unixTime": { "type": "boolean", "nullable": true }, "subaffiliate": { "type": "string", "nullable": true }, "sharedId": { "type": "string", "nullable": true }, "customerId": { "type": "string", "nullable": true }, "user": { "type": "object", "additionalProperties": false, "required": [ "browser", "city", "countryCode", "crossDevice", "deviceModel", "deviceOperatingSystem", "deviceType", "district", "postCode", "repeatCustomer" ], "properties": { "browser": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "crossDevice": { "type": "boolean", "nullable": true }, "deviceModel": { "type": "string", "nullable": true }, "deviceOperatingSystem": { "type": "string", "nullable": true }, "deviceType": { "type": "string", "nullable": true }, "district": { "type": "string", "nullable": true }, "postCode": { "type": "string", "pattern": "^\\d+$", "nullable": true }, "repeatCustomer": { "type": "boolean", "nullable": true } } }, "checkInDate": { "type": "string", "format": "datetime", "nullable": true }, "checkOutDate": { "type": "string", "format": "datetime", "nullable": true }, "nightsStayed": { "type": "integer", "minimum": 1 }, "roomCount": { "type": "integer", "minimum": 1 }, "customField1": { "type": "string", "nullable": true }, "customField2": { "type": "string", "nullable": true }, "customField3": { "type": "string", "nullable": true }, "customField4": { "type": "string", "nullable": true }, "customField5": { "type": "string", "nullable": true }, "customField6": { "type": "string", "nullable": true }, "customField7": { "type": "string", "nullable": true }, "customField8": { "type": "string", "nullable": true }, "customField9": { "type": "string", "nullable": true }, "customField10": { "type": "string", "nullable": true }, "customField11": { "type": "string", "nullable": true }, "customField12": { "type": "string", "nullable": true }, "customField13": { "type": "string", "nullable": true }, "customField14": { "type": "string", "nullable": true }, "customField15": { "type": "string", "nullable": true }, "customField16": { "type": "string", "nullable": true }, "customField17": { "type": "string", "nullable": true }, "customField18": { "type": "string", "nullable": true }, "customField19": { "type": "string", "nullable": true }, "customField20": { "type": "string", "nullable": true }, "discount": { "type": "number", "multipleOf": 0.01 } } } } } } }, "400": { "description": "Default Response", "content": { "application/stream+json": { "schema": { "additionalProperties": false, "properties": { "error": { "default": "Bad Request", "type": "string" }, "message": { "default": "Any 'sort' field must be included as one of the categories or metrics. The following 'sort' fields were not included in either: mistake.", "type": "string" }, "statusCode": { "default": 400, "type": "integer" } }, "required": [ "statusCode", "error", "message" ], "title": "Bad Request Error", "type": "object" } } } } } } } }, "servers": [ { "url": "https://yourAgencyName-api.affluent.io", "description": "agency server" } ], "tags": [ { "name": "action", "description": "/action" } ] } ````