Standard Logs
The standard logs stored within the Data Shipping logs include:
Impression Logs
Name | Description | Sample Data | Type |
---|---|---|---|
Id | The unique Impression ID | "83ea1dc7160f4 83397eb6f5d1c4e62aa" | string |
AdTypeId | The numeric ID of an ad size. Sourced from the event shim | 162 | int |
AuctionBids | The number of non-RTB ads competing for the impression in an Auction priority. If the ad served was selected outside of an Auction priority, then this AuctionsBids value will be zero. Note that this field is absent unless there is at least one auction bid in the event shim | 78 | int |
BrandId | The numeric ID of the impression's advertiser. Sourced from the event shim | 554125 | int |
BidModifier | The bid modifier that was applied (not present if no bid modifier was matched) | { "match": { "keyword": "x" }, "multiplier": 2 } | object |
BurnIn | If 1 , the impression/click/event was served when an eCPM optimized flight was in a "burn-in" period. | TRUE | boolean |
CampaignId | The numeric ID of the impression's campaign. Sourced from the event shim | 1331048 | int |
Categories | An array of behavior targeting categories, set by the impression's flight. Sourced from the event shim, absent if absent in the shim | [] | array |
ChannelId | The numeric ID of the impression's channel. Sourced from the event shim | 40304 | int |
CreativeId | The numeric ID of the impression's creative. Sourced from the event shim | 16458736 | int |
CreatedOn | A time/date stamp (milliseconds since UNIX epoch) that indicates when the impression happened | "/Date(1581038413783)/" | int (date) |
CreativePassId | The numeric ID of the impression's ad (creative mapped to flight). Sourced from the event shim | 19126348 | int |
Datacenter | If true, the event originates from a TAG known datacenter. | FALSE | boolean |
DecisionId | The ID of the Decision associated with the impression/click/event | “7fb50ca376064d9ba 50005e24535f4c9” | string |
DecisionIdx | Decision Index. If the Decision generates only one Selection (i.e. it does not originate from a multi-winner placement) then the DecisionIdx will always be 0 . For multi-winner placements, the DecisionIdx will be the order of the Selection within the Decision (zero indexed). | 0 | int |
DeliveryMode | 1 = Web (served by ados.js tags) 2 = Email (served by HTML tags) 3 = API (served by REST call) 4 = Static Tracking Link (served by GIF) | 3 | int |
Device.brandName | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.modelName | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.osRawVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.osMajorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 0 | int |
Device.osMinorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 0 | int |
Device.advertisedOsRawVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | “10.14“ | string |
Device.advertisedOsMajorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 10 | int |
Device.advertisedOsMinorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 14 | int |
Device.advertisedOs | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | “Mac OS X“ | string |
Device.browser | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.browserRawVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.browserMajorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 0 | int |
Device.browserMinorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 0 | int |
Device.deviceIdentified | Confirms if the client device used has been successfully identified (not identified as 'generic') | true | boolean |
Device.formFactor | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | “desktop” | string |
Ecpm | Calculated ECPM of the impression/click/event | 830.070956 | float |
EcpmPartition | eCPM Partitions track the eCPM performance data of ads separately for different partitions of your inventory. More info here: https://dev.kevel.com/docs/ecpm-partitions | null | string |
EventCreatedOn | When the impression event occurred, as a UNIX timestamp | 1581038414099 | long |
FirstChannelId | Deprecated | 40304 | int |
FrequencyCap | The type(s) of frequency capping applied to the impression. Logged as the decimal value of a hex bit flag:FlightCapped: 0x00000001 AdCapped: 0x00000010 CampaignCapped: 0x00000100 AdvertiserCapped: 0x00001000 FlightDoesNotAffectParent: 0x00010000 AdDoesNotAffectParent: 0x00100000 CampaignDoesNotAffectParent: 0x01000000 For instance, an impression with both a flight cap and ad cap has a flag of 0x00000011 , i.e. decimal 17 . | 17 | int |
GdprComputed | If true, the request has GDPR consent (from the request itself, from a UserDB record, etc.) | TRUE | boolean |
GdprConsentRequired | If true, the gdprConsentRequired parameter was provided on the request, indicating that the user was subject to GDPR regulation (even if they didn't use an EU IP address). | FALSE | boolean |
GdprConsentString | The IAB consent string provided with the request if the string was used when computing GDPR consent. | ““ | string |
GdprIsEU | If true, the request originates from the EU, the UK, or Switzerland. | TRUE | boolean |
GdprSource | Where GDPR consent data (true or false ) originates:none - no consentrequest - on the ad requestuserdb - on the user recordboth - both user record and requeststr - from an IAB consent string + allowed vendor ID | "none" | string |
GdprVendorId | The vendor ID provided in the request (if available). | 1234 | int |
Gmv | Gross Merchandise Value. Sourced from the event URL if appended as a query parameter. Calculated by taking the gmv parameter on the event URL and multiplying by 1,000,000. | 1000000 | int |
GrossRevenue | 0 | int | |
ImpressionCount | Refers to the number of impressions registered if Event Multipliers are used. Default is 1 | 1 | int |
ImpressionCreatedOn | Records the time this Event was created in the server, as a UNIX timestamp | 1581038413783 | long |
IsNoTrack | If true , the impression was served to a Do Not Track enabled user (boolean) | FALSE | boolean |
IsPublisherPayoutExempt | FALSE | boolean | |
IsRemainder | If true , the impression was served as part of the "Remainder Percentage" in an auction priority. IsRemainder is only logged when true . | FALSE | boolean |
IsTrackingCookieEvents | If true , the impression is tracking conversions. Sourced from the event shim (boolean) | FALSE | boolean |
IsPublisherPayoutExempt | Deprecated (boolean) | FALSE | boolean |
IsValidUA | If true, the impression passed the bots and spiders filter (boolean) | TRUE | boolean |
Keywords | Keyword(s) sent on the request, converted into a comma separated string. Sourced from the event shim | "fpfdvrmwggl4z,j7sr2ywldd 6m,dt7zi5mlfrrs7,kr74uow fsyyzp" | string (comma delimited) |
Location.CountryCode | An array of location data from the request. Sourced from the ad request, NOT the event shim | "AU" | string |
Location.CountryName | See above | "Australia" | string |
Location.Region | See above | "NSW" | string |
Location.City | See above | "Sydney" | string |
Location.DmaCode | See above | ||
Location.MetroCode | See above | ||
Location.PostalCode | See above | "2000" | string |
Location.Latitude | See above | 0 | int |
Location.Longitude | See above | 0 | int |
Matching Keywords | Keyword(s) present in the ad. Sourced from the event shim | ["j7sr2ywlddf6m", "hh7sr2ywlddf6"] | array[string] |
ModifiedPrice | The price after bid modifier was applied -- if no bid modifier was applied this will be the same as the Price | "12.02" | string |
Meta:schema | The type of log - will always be event | "event" | string |
Meta:version | The version of the log format this log object uses | "1.3" | string |
NetRevenue | 0 | int | |
NetworkId | The numeric ID of the impression's network. Sourced from the event shim | 10322 | int |
OptimizedPrice | The price set by a bid optimizer (eg in ROAS targeting) and is distinct from the initial price, both are logged. See https://dev.kevel.com/docs/gmv-and-roas#what-is-autobid | 26 | number |
PassId | The numeric ID of the impression's flight. Sourced from the event shim | 11082877 | int |
PhantomCreativePassId | Internal - used during phantom mode for impression goal ads. Sourced from the event shim | 0 | int |
PlacementName | The name of the Placement object or <div> that served the ad. Sourced from the event shim | "placement 1" | string |
PhantomPassId | Internal - used during phantom mode for impression goal ads. Sourced from the event shim | 0 | int |
PriorityId | The numeric ID of the impression's priority. Sourced from the event shim | 161492 | int |
Price | The price per unit (CPA, CPM, CPC etc.) associated with the impression. Returned as a string. Sourced from the event shim | "6.01" | string |
RateType | The rate used by the flight. Sourced from the event shim:1 - Flat 2 = CPM 3 = CPC 4 = CPA View 5 = CPA Click 6 = CPA Both | 3 | int |
ReferrerUrl | The URL that led to the page that hosted the ad request. Sourced from the event shim | ||
RelevancyScore | 500 | int | |
Revenue | Revenue generated via the event(impression/click). Calculated by taking the revenue field in the event shim and multiplying by 1,000,000 (in order to support very small prices, such as $0.01 CPM). For instance, if a flight has a Price of $50 CPM, each impression will have $0.05 of revenue associated with it. Multiplying that by 1,000,000 yields a Revenue value of 50000 on the impression record. | 0 | int |
RemoteIP | Due to GDPR regulation, this is sanitized as 0.0.0.0 instead of the IP address. You can optionally log IP addresses if the request or user record IP address does not originate from a GDPR regulated area | "0.0.0.0" | string |
RtbBids | The number of RTB bids competing for the impression. Remember, RTB ads can be used in any priority type. Also, please note that some RTB partners provide more than one bid per request, but most only provide one. Sourced from the event shim | ||
ServedBy | "i-0ecaf52dd4dba2672" | string | |
ServedByAsg | "bifrost-adservers-default- us-east-1" | string | |
ServedByPid | 43473 | int | |
SiteId | The numeric ID of the impression's site. Sourced from the event shim | 1086974 | int |
TimeZoneId | The time zone of the flight. If no time zone is explicitly set, defaults to "UTC" . Sourced from the event shim | string | |
Url | The URL of the page the ad served on. This may be missing if there was no referrer header on the request. Sourced from the ad request | string | |
User.Key | An array of user data (in UserDB) associated with the impression. Contains two fields: the Key, and whether or not this is a new user. Sourced from either the UserDB record or the user's azk cookie | "ue1-3542a229b8be4109 bcad892fc317ddfa" | string |
User.IsNew | FALSE | boolean | |
User.Type | Where user data was stored/retrieved from:1 = Cookie 2 = UserDB | int | |
UserAgent | Deprecated for privacy purposes. User agent data can now be found in the Device object | ““ | string |
UserKey | The user Key (used by UserDB) associated with the impression. Sourced from the ad request | "ue1-3542a229b8be4109 bcad892fc317ddfa" | string |
ZoneId | The numeric ID of the impression's zone (if applicable). Sourced from the event shim | 0 | int |
Click Logs
The JSON objects for other events use the same format as the impression object. Additional parameters for clicks (or parameters with differences):
Name | Description | Sample Data | Type |
---|---|---|---|
Id | The unique Click ID | "71f5686388df4fd99 fbf43b96eeb4946" | string |
AdTypeId | The numeric ID of an ad size. Sourced from the event shim | 162 | int |
BrandId | The numeric ID of the impression's advertiser. Sourced from the event shim | 554125 | int |
BurnIn | True if in initial/learning phase | ||
CampaignId | The numeric ID of the impression's campaign. Sourced from the event shim | 1331048 | int |
Categories | An array of behavior targeting categories, set by the impression's flight. Sourced from the event shim, absent if absent in the shim | [] | array |
ChanelId | |||
ClickBuckets | Whether the click was bucketed as Unique , with the schema "Unique": {"Value": true/false} . Refer to the click bucketing docs for details | ||
ClickCount | Refers to the number of clicks registered if Event Multipliers are used. Default is 1 | int | |
CreativeId | The numeric ID of the impression's creative. Sourced from the event shim | 16458736 | int |
CreatedOn | A time/date stamp (milliseconds since UNIX epoch) that indicates when the impression happened | "/Date(1581038413783)/" | int (date) |
CreativePassId | The numeric ID of the impression's ad (creative mapped to flight). Sourced from the event shim | 19126348 | int |
Datacenter | If true, the event originates from a TAG known datacenter. | FALSE | boolean |
DecisionId | The ID of the Decision associated with the impression/click/event | “7fb50ca376064d9b a50005e24535f4c9” | string |
DecisionIdx | 0 | int | |
DeliveryMode | 1 = Web (served by ados.js tags) 2 = Email (served by HTML tags) 3 = API (served by REST call) 4 = Static Tracking Link (served by GIF) | 3 | int |
Device.brandName | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.modelName | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.osRawVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.osMajorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 0 | int |
Device.osMinorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 0 | int |
Device.advertisedOsRawVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | “10.14“ | string |
Device.advertisedOsMajorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 10 | int |
Device.advertisedOsMinorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 14 | int |
Device.advertisedOs | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | “Mac OS X“ | string |
Device.browser | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.browserRawVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ““ | string |
Device.browserMajorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 0 | int |
Device.browserMinorVersion | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | 0 | int |
Device.deviceIdentified | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | ||
Device.formFactor | Device fields are from the WURFL field set, see http://wurfl.sourceforge.net/ | “desktop” | string |
Ecpm | Calculated ECPM of the impression/click/event | 830.070956 | float |
EcpmPartition | Value pased in during decision request. See https://dev.kevel.com/docs/ecpm-partitions (may be NULL) | ||
EventCreatedOn | When the click event occurred, as a UNIX timestamp | 1581038414099 | long |
FirstChannelId | Deprecated | 40304 | int |
Fradulent | True if matches the IAB/TAG group for fraudulent IPs/datacenter traffic | ||
GdprComputed | If true, the request has GDPR consent (from the request itself, from a UserDB record, etc.) | TRUE | boolean |
GdprConsentRequired | If true, the gdprConsentRequired parameter was provided on the request, indicating that the user was subject to GDPR regulation (even if they didn't use an EU IP address). | FALSE | boolean |
GdprConsentString | The IAB consent string provided with the request if the string was used when computing GDPR consent. | ““ | string |
GdprIsEU | If true, the request originates from the EU, the UK, or Switzerland. | TRUE | boolean |
GdprSource | Where GDPR consent data (true or false ) originates:none - no consentrequest - on the ad requestuserdb - on the user recordboth - both user record and requeststr - from an IAB consent string + allowed vendor ID | "none" | string |
Gmv | Gross Merchandise Value. Sourced from the event URL if appended as a query parameter. Calculated by taking the gmv parameter on the event URL and multiplying by 1,000,000. | 1000000 | int |
GrossRevenue | 0 | int | |
ImpressionCount | Refers to the number of impressions registered if Event Multipliers are used. Default is 1. | 1 | |
ImpressionCreatedOn | Records the time this Event was created in the server, as a UNIX timestamp | 1581038413783 | long |
ImpressionId | The Impression ID | "83ea1dc7160f4 83397eb6f5d1c4e62aa" | string |
IsNoTrack | If true, the impression was served to a Do Not Track enabled user (boolean) | FALSE | boolean |
IsPublisherPayoutExempt | Deprecated (boolean) | FALSE | boolean |
IsRemainder | If true, the impression was served as part of the "Remainder Percentage" in an auction priority. IsRemainder is only logged when true. | FALSE | boolean |
IsTrackingCookieEvents | If true, the impression is tracking conversions. Sourced from the event shim (boolean) | FALSE | boolean |
IsValidUA | If true, the impression passed the bots and spiders filter. Sourced from the click request (boolean) | TRUE | boolean |
Keywords | Keyword(s) sent on the request, converted into a comma separated string. Sourced from the event shim | "fpfdvrmwggl4z,j7sr2y wlddf6m,dt7zi5mlfrrs7 ,kr74uowfsyyzp" | string (comma delimited) |
Location.CountryCode | An array of location data from the request. Sourced from the click request, NOT the ad request | "AU" | string |
Location.CountryName | see above | "Australia" | string |
Location.Region | see above | "NSW" | string |
Location.City | see above | "Sydney" | string |
Location.DmaCode | see above | ||
Location.MetroCode | see above | ||
Location.PostalCode | see above | "2000" | string |
Location.Latitude | see above | 0 | int |
Location.Longitude | see above | 0 | int |
Matching Keywords | Keyword(s) present in the ad. Sourced from the event shim | ["j7sr2ywlddf6m", "hh7sr2ywlddf6"] | array[string] |
Meta:schema | The type of log - will always be event | "event" | string |
Meta:version | The version of the log format this log object uses | 0 | string |
NetRevenue | 0 | int | |
NetworkId | The numeric ID of the impression's network. Sourced from the event shim | 10322 | int |
PassId | The numeric ID of the impression's flight. Sourced from the event shim | 11082877 | int |
PlacementName | The name of the Placement object or that served the ad. Sourced from the event shim | "placement 1" | string |
PriorityId | The numeric ID of the impression's priority. Sourced from the event shim | 161492 | int |
Price | The price per unit (CPA, CPM, CPC etc.) associated with the impression. Returned as a string. Sourced from the event shim | "6.01" | string |
RateType | The rate used by the flight. Sourced from the event shim: 1 = Flat, 2 = CPM, 3 = CPC, 4 = CPA View, 5 = CPA Click, 6 = CPA Both | 3 | int |
RelevancyScore | 500 | int | |
RemoteIP | This is sanitized as 0.0.0.0 instead of the IP address | "0.0.0.0" | string |
Revenue | Revenue generated via the impression. Calculated by taking the revenue field in the event shim and multiplying by 1,000,000 | 0 | int |
ServedBy | Kevel internal | ||
ServedByAsg | Kevel internal | ||
ServedByPid | Kevel internal | ||
SiteId | The numeric ID of the impression's site. Sourced from the event shim | 1086974 | int |
TimeZoneId | |||
Url | The URL of the page the ad served on. This may be missing if there was no referrer header on the request. Sourced from the click request | ||
User | An array of user data (in UserDB) associated with the impression. Contains two fields: the Key, and whether or not this is a new user. Sourced from the click request | ||
UserAgent | The string of the user agent that created the impression. Sourced from the click request | ““ | string |
UserKey | The user Key (used by UserDB) associated with the impression. Sourced from the click request | "ue1-3542a229b8be4109 bcad892fc317ddfa" | string |
ZoneId | The numeric ID of the impression's zone (if applicable). Sourced from the event shim | 0 | int |
Conversion Logs
The JSON objects for other events use the same format as the impression object. Additional parameters for conversions (or parameters with differences):
Name | Description |
---|---|
CreatedOn | (Deprecated) When the impression associated with the conversion occurred, as a UNIX timestamp |
EventCreatedOn | When the conversion occurred, as a UNIX timestamp |
ImpressionCreatedOn | Records the time this Event was created in the server, as a UNIX timestamp |
IsValidUA | If true, the impression passed the bots and spiders filter. Sourced from the conversion request (boolean) |
Location | An array of location data from the request. Sourced from the conversion request, NOT the ad request |
RemoteIP | This is sanitized as 0.0.0.0 instead of the IP address |
Url | The URL of the page the ad served on. This may be missing if there was no referrer header on the request. Sourced from the conversion request |
User | An array of user data (in UserDB) associated with the impression. Contains two fields: the Key, and whether or not this is a new user. Sourced from the conversion request |
UserAgent | The string of the user agent that created the impression. Sourced from the conversion request |
UserKey | The user Key (used by UserDB) associated with the impression. Sourced from the conversion request |
Custom Event Logs
The JSON objects for other events use the same format as the impression object. They have the same additional parameters as conversions, with two notable differences:
Custom event logs have an additional
EventId
field that is the ID of the custom event type. (For example, anEventId
of 10 is anUpvote
event.)The logs also contain a
CustomEventCount
field that refers to the number of Custom Events registered if Event Multipliers are used. Default is 1.
For "EventId": 3 generated from the purchase event endpoint the following parameters will be present
Name | Description |
---|---|
AttributedPurchaseMetadata.UserKey | The array of user keys supplied with the purchase event. |
AttributedPurchaseMetadata.Timestamp | The timestamp supplied via the purchase event. |
AttributedPurchaseMetadata.Quantity | The quantity of items in this transaction (line item of an order) |
AttributedPurchaseMetadata.Price | The product price of the line item. |
AttributedPurchaseMetadata.TransactionId | The transaction identifier |
AttributedPurchaseMetadata.ProductId | The product identifier, used to lookup product meta data in the Kevel Catalog |
AttributedPurchaseMetadata.LtvQuantity | The expected additional quantity of items sold to this customer. |
AttributedPurchaseMetadata.LtvValue | The expected additional sales value sold to this customer. |
Updated 3 months ago