Jump to
Close
Cognition API
Last updated June 01, 2023
Optional Parameters:
| Parameter | Format | Description |
| numDays | 1-7 | Returns data from the current date minus the number of days |
| startDate | yyyy-MM-dd | Returns data between the start and end dates |
| endDate | yyyy-MM-dd | Required when specifying startDate |
| cognitionAdvertiserId | Numeric | Id of an Advertiser assigned to your Agency |
Advertisers
GET
https://platform.cognitiondigital.io/api/analytics/advertisers
| Category | Field Name | Definition | Example | Data Type |
| Identification | advertiserName | Name of Advertiser | Big Win Auto | varchar(255) |
AmcAttribution - Offline Matchback Attribution Data Points
GET
https://platform.cognitiondigital.io/api/analytics/AmcAttribution
| Category | Field Name | Definition | Example | Data Type |
| Identification | CognitionAdvertiserID | |||
| Identification | advertiserName | Name of Advertiser | Big Win Auto | varchar(255) |
| Campaign Detail | campaignName | Name of the campaign running for the advertiser | varchar(80) | |
| Campaign Detail | date | Date (aggregated in month) when attribution occurred | 7/3/22 | date |
| Campaign Detail | dataSetName | Name of the type of data being submitted for Attribution | Sales | varchar(30) |
| Campaign Detail | recordsSubmitted | Count of records submitted for dataset attribution | 100 | int |
| Campaign Detail | matchedAmazonRecords | Count of records found in Amazon Prime member list that match to the records submitted | 60 | int |
| Campaign Detail | attributedUserRecords | Count of records that matched to an attributable ad conversion | 9 | int |
| Campaign Detail | adBudget | Budgeted flight amount | 3000 | decimal(10,2) |
| Campaign Detail | adSpend | Actual flight spent amount | 998.89 | decimal(10,2) |
| Campaign Detail | gross | Aggregate gross on AttributedUserRecords | 32851.2 | decimal(10,2) |
CogDevice - User Device / identify mobile vs desktop / OS
GET
https://platform.cognitiondigital.io/api/analytics/CogDevice
| Category | Field Name | Definition | Example | Data Type |
| Identification | CognitionAdvertiserID | |||
| Identification | advertiserName | Name of Advertiser | varchar(255) | |
| Campaign Detail | date | Date of ad display | date | |
| Campaign Detail | placementDimension | Ad size if applicable | 300x600 | varchar(255) |
| Campaign Detail | placementType | Media description | In-Stream Video | varchar(255) |
| Campaign Detail | adName | Name of the ad at the ad server | varchar(255) | |
| Campaign Detail | impressions |
(MRC Accredited) Total number of impressions that were not identified as GIVT
|
int | |
| Campaign Detail | clicks |
(MRC Accredited) Total numbers of clicks tracked from all ads, excluding Default Interactions from Tracked Ads (clicks on the ads served from <noscript> of a Rich Media creative)
|
int | |
| Campaign Detail | totalInteractions |
Total number of user-initiated interactions. Including clicks, opening a panel, video mute, video sound on, video pause, full screen video mode start/pause/end, and any custom interactions defined in an ad
|
int | |
| Campaign Detail | totalConversions | All conversions that occurred as a result of an ad impression or an ad click | int | |
| Campaign Detail | deviceBrandName | User Device brand name | Apple | varchar(255) |
| Campaign Detail | osName | Device operating System | iOS | varchar(255) |
| Campaign Detail | deviceModelName | Device Model name | iPhone14 | varchar(255) |
| Campaign Detail | deviceType | Tablet, Phone, PC | smartphone | varchar(255) |
DailyConvDetails - Conversion Details - post click user metrics
GET
https://platform.cognitiondigital.io/api/analytics/DailyConvDetails
| Category | Field Name | Definition | Example | Data Type |
| Identification | CognitionAdvertiserID | |||
| Identification | advertiserName | Name of Advertiser | varchar(255) | |
| Identification | siteName | Name of the website where conversion tracker collected conversion data | varchar(255) | |
| Identification | campaignName | Name of the campaign running for the advertiser | varchar(255) | |
| Identification | placementName | Name of the ad placement running in the campaign | varchar(255) | |
| Identification | adName | Name of the ad defined at the ad server | varchar(255) | |
| Campaign Detail | date | date | ||
| Campaign Detail | currency | Monetary currency of the ad | US dollar | varchar(255) |
| Campaign Detail | conversionActivityName | Description of the conversion activity as specified in tracking logic | Big Win Auto - SessionView_1 | varchar(255) |
| Campaign Detail | placementDimension | Size of the placement | 300x250 | varchar(255) |
| Campaign Detail | sectionName | Description of site placement section | 0 | varchar(255) |
| Campaign Detail | placementType | Description of the type of creative | In Banner | varchar(255) |
| Campaign Detail | totalConversions | All conversions that occurred as a result of an ad impression or click | int | |
| Campaign Detail | totalConversionsRate | Percentage of conversions out of served impressions | decimal(6,2) | |
| Campaign Detail | clickToConversionRate | Percentage of conversions out of the ad's Total Clicks | decimal(6,2) | |
| Campaign Detail | postClickConversions |
Number of conversions that occurred due to an impression, after clicking the ad
|
int | |
| Campaign Detail | postClickConversionRate | Average number of served impressions for each post-click conversion | decimal(6,2) | |
| Campaign Detail | postImpressionConversions |
Number of conversiosn that occurred due to an impression, without clicking on the ad
|
int | |
| Campaign Detail | postImpressionConversionRate |
Average number of served impressiosn for each post-impression conversion
|
decimal(6,2) | |
| Campaign Detail | postImpressionLatentConversions |
Number of conversions occurring more than 12 hours after (and as a result of) an impression
|
int | |
| Campaign Detail | postClickImpulseConversions |
Number of conversions occurring less than 12 hours after (and as a result of) an ad click
|
int | |
| Campaign Detail | postClickLatentConversions |
Number of conversions occurring more than 12 hours after(and as a result of) an ad click
|
int | |
| Campaign Detail | postImpressionImpulseConversions |
number of conversions occurring less than 12 hours after (and as a result of) an impression
|
int | |
| Campaign Detail | conversionRevenue |
Total income recorded by sales type conversion tags and counter type conversion tags. Uses the account's currency. If Path-to-conversion, then revenue is shared with each conversion. If single-event reporting on event immediately prior to conversion, then all revenue is summed in this conversion
|
decimal(10,2) |
DspImpressions - Ad Impression Metrics
GET
https://platform.cognitiondigital.io/api/analytics/DspImpressions
| Category | Field Name | Definition | Example | Data Type |
| Identification | CognitionAdvertiserID | |||
| Identification | advertiserName | Name of Advertiser | varchar(255) | |
| Identification | orderName | Name of the Order at the DSP | varchar(255) | |
| Identification | lineId | Id of the Line Item at the DSP | varchar(255) | |
| Identification | lineItem | Name of the Line Item at the DSP | varchar(255) | |
| Identification | creativeId | Id of the ad creative at the DSP | varchar(255) | |
| Identification | creative | Name of the ad creative at the DSP | varchar(255) | |
| Campaign Detail | date | Date of the ad impression | date | |
| Campaign Detail | totalCost | Total amount spent running the campaign | decimal(10,2) | |
| Campaign Detail | impressions |
Number of times ad displayed, excluding - GIVT - general invalid traffic (potentially fraudulent, non-human, or other illegitmate impressions)
|
int | |
| Campaign Detail | eCPM | Effective total cost per thousand impressions | decimal(10,5) | |
| Campaign Detail | viewableImpressions |
(MRC Certified) Number of times an ad was view by customers. Viewable definition is generally 50% ad visible for 1 second or longer for display ads and 2 seconds or longer for video ads.
|
int | |
| Campaign Detail | measurableImpressions | Number of impressions that were measured for viewability | int | |
| Campaign Detail | viewabilityRate | Viewable Impressions / measurable impressions | decimal(10,4) | |
| Campaign Detail | clickThroughs | Number of times the ad was clicked, excluding general invalid traffic | int |
| Campaign Detail | ctr | Number of click-throughs relative to the number of impressions | decimal(10,4) | |
| Campaign Detail | totalPixel |
Number of pixel conversions (Deprecated 1/1/2023 - please refer to offAmazonConversions instead)
|
int | |
| Campaign Detail | videoStart | Number of times users started a video ad | int | |
| Campaign Detail | videoFirstQuartile | Number of users who watched through the first quarter of a video ad | int | |
| Campaign Detail | videoMidpoint | Number of users who watched through the first half of a video ad | int | |
| Campaign Detail | videoThirdQuartile | Number of users who watched through the third quarter of a video ad | int | |
| Campaign Detail | videoComplete | Number of users who watched through the full video ad | int | |
| Campaign Detail | audioStart | Number of times users started an audio ad | int | |
| Campaign Detail | audioFirstQuartile | Number of users who listened through the first quarter of audio ad | int | |
| Campaign Detail | audioMidpoint | Number of users who listened through the first half of audio ad | int | |
| Campaign Detail | audioThirdQuartile | Number of users who listened through the third quarter of audio ad | int | |
| Campaign Detail | audioComplete | Number of users who listened through the full audio ad | int | |
| Campaign Detail | dailyReach |
Number of unique users who were exposed to the creative on specified date
|
int | |
| Campaign Detail | avgImpressionFrequency | Average number of exposures to the creative per unique user | int | |
| Campaign Detail | offAmazonConversions |
Number of conversions that occured off Amazon attributed to an ad view or click. This includes all conversion types.
|
int | |
| Campaign Detail | offAmazonConversionRate |
Number of off-Amazon conversions relative to the number of ad impressions. (Off-Amazon conversions / Impressions)
|
decimal(10,4) |
DspSummaryAppBySpend - Aggregated Ad Placement Details - Summarized by monthly total per campaign flight
GET
https://platform.cognitiondigital.io/api/analytics/DspSummaryAppBySpend
| Category | Field Name | Definition | Example | Data Type |
| Identification | CognitionAdvertiserID | |||
| Identification | advertiserName | Name of Advertiser | varchar(255) | |
| Identification | orderName | Name of the Order at the DSP | varchar(255) | |
| Campaign Detail | date | Date of the ad impression aggregated to a selected date in a month | date | |
| Campaign Detail | startDate | Start date of the aggregation window | date | |
| Campaign Detail | endDate | End date of the aggregation window | date | |
| Campaign Detail | site | Site that the ad was displayed on | varchar(255) | |
| Campaign Detail | poNumber | Purchase Order tracking number in DSP | varchar(255) | |
| Campaign Detail | totalCost | Total cost of the campaign within the aggregation window by site | decimal(10,2) | |
| Campaign Detail | impressions | Total impressions delivered within the aggregation window by site | int |
Geo - Geographical Ad Placement Information
GET
https://platform.cognitiondigital.io/api/analytics/Geo
| Category | Field Name | Definition | Example | Data Type |
| Identification | CognitionAdvertiserID | |||
| Identification | advertiserName | Name of Advertiser | varchar(255) | |
| Identification | campaignName | Name of the campaign running for the advertiser | varchar(255) | |
| Identification | placementName | Name of the ad placement running in the campaign | BigWinAuto_Static Vehicle Aqui_160x600_InMarket Owners | varchar(255) |
| Campaign Detail | date | Date that the ad was served | date | |
| Campaign Detail | siteName | Site of the purchasing platform | Amazon DSP US | varchar(255) |
| Campaign Detail | country | Country of the user who viewed the ad | United States | varchar(80) |
| Campaign Detail | state | State of the user who viewed the ad | Virginia | varchar(80) |
| Campaign Detail | city | City of the user who viewed the ad | Ashburn | varchar(80) |
| Campaign Detail | dma | Market of the user who viewed the ad | Washington Dc (Hagrstwn) | varchar(80) |
| Campaign Detail | placementDimension | Ad Size displayed | 1920x1080 | varchar(80) |
| Campaign Detail | placementType | Type of creative that the ad server placed in ad | In Stream video | varchar(80) |
| Campaign Detail | impressions | Number of impressions served not identified as GIVT | int | |
| Campaign Detail | clicks |
Number of clicks tracked from all ads, excluding Default Interations from Tracked Ads
|
int | |
| Campaign Detail | ctr | Percentage of clicks out of the number of served impressions | decimal(10,0) | |
| Campaign Detail | totalInteractions |
Number of user-initiated interactions. Can include clicks, opening panel, video (un)mute, video pause, full screen mode start/pause/end, and any custom defined interaction
|
int | |
| Campaign Detail | interactionRate | Ratio of total interactions to served impressions | decimal(10,2) | |
| Campaign Detail | totalConversions | All conversions that occurred as a result of an ad impression or an ad click | int | |
| Campaign Detail | conversionRevenue |
Income recoded by sales-type conversion tags and counter-type conversion tags, in the account's set currency. When considering the entire path-to-conversion, the revenue from each conversion is shared equally between all sites in the path to conversion. When considering the single event immediately prior to the conversion, this is the sum of the values for all conversions.
|
decimal(10,2) |
SumPlaceType - Impression Metrics by Dimension
GET
https://platform.cognitiondigital.io/api/analytics/SumPlaceType
| Category | Field Name | Definition | Example | Data Type |
| Identification | CognitionAdvertiserID | |||
| Identification | siteName | Site of the purchasing platform | Amazon DSP US | varchar(255) |
| Identification | placementName | Name of the ad placement running in the campaign | BigWinAuto_Static Vehicle Aqui_160x600_InMarket Owners | varchar(255) |
| Identification | adName | Name of the ad defined at the ad server | BigWinAuto_OTT_30 | varchar(255) |
| Campaign Detail | date | Date that the ad was served | date | |
| Campaign Detail | placementDimension | Ad Size displayed | 160x600 | varchar(255) |
| Campaign Detail | sectionName | Section Name on the site where the ad was placed (if applicable) | varchar(255) | |
| Campaign Detail | advertiserName | Name of Advertiser | Big Win Auto | varchar(255) |
| Campaign Detail | placementType | Type of creative that the ad server placed in ad | In Banner | varchar(255) |
| Campaign Detail | impressions | Number of impressions by the placement type | int | |
| Campaign Detail | clicks | Number of clicks recorded on the ad by the placement type | int | |
| Campaign Detail | totalConversions |
All conversions that occurred as a result of an ad impression or an ad click by the placement type
|
int |
GeoSummary - Aggregated Geographical Ad Placement Information - Summarized by monthly total per campaign flight
GET
https://platform.cognitiondigital.io/api/analytics/GeoSummary
| Category | Field Name | Definition | Example | Data Type |
| Identification | CognitionAdvertiserID | |||
| Identification | Global ID | |||
| Identification | orderName | Name of the Order at the DSP | varchar(255) | |
| Campaign Detail | date | Date that the ad was served | date | |
| Campaign Detail | startDate | Start date of the aggregation window | date | |
| Campaign Detail | endDate | End date of the aggregation window | date | |
| Campaign Detail | advertiserName | Name of Advertiser | varchar(255) | |
| Campaign Detail | state | State of the user who viewed the ad | Virginia | varchar(80) |
| Campaign Detail | city | City of the user who viewed the ad | Ashburn | varchar(80) |
| Campaign Detail | zipCode | ZipCode of the user who viewed the ad | varchar(20) | |
| Campaign Detail | impressions | Number of impressions by the placement type | int | |
| Campaign Detail | clickThroughs |
Number of clicks tracked from all ads, excluding Default Interations from Tracked Ads
|
int | |
| Campaign Detail | offAmazonConversions | int |
