Changes in API

We introduce changes in API commands.

Please, be aware that some of the changes are not backward compatible:

GetSSPStats command

• new withNames parameter which takes as input values: "Y" or "N"

GetVideoStats command

From now on, this command reads new video statistics. All video campaigns active within last 10 months are already calculated and available under that command. New module calculates stats faster and has much lower delay. Please note: Also new stat values can slightly differ from stats from old module available in GetVideoStatsOld command. More information below.

Input in this command:

Also statistics and their names are changed. Some are removed or added. A detailed description of the changes can be found below in the explanation of GetVideoStatNames and GetStatNamesList commands

NEW GetVideoStatsOld command

Old command GetVideoStats has been moved to GetVideoStatsOld. It allows to read video statistics for old campaigns. We do not recommend use it for new campaigns, as calculation for old statistics will be turned off at some point without prior notification.

GetVideoStatNames command

• takes only sessionID as an input
• no division into cookie / no cookie statistics names. In other words all statistics with cookie in the name are removed
• The following stats have been renamed:
• allcompletedmaterials -> videoAllCompletedMaterials
• uniqueuserscompletedmaterials -> videoUniqueUsersCompletedMaterials
• allinteractions -> videoInteractionsAll
• uniqueusersallinteractions -> videoUniqueUsersInteractions
• TimeRange -> videoTimeRangeInteractions
• The following stats has been removed:
• allstreams (available in GetBasicStats as emissions)
• uniqueusersstreams (available in GetBasicStats as reach)
• allclicks (available in GetBasicStats as allclicks)
  
• frequency (available in GetBasicStats as frequency)

GetStatNamesList 

• Command no longer returnes statDomainNames associated with video: video, videoTimeRange, videoProgress (Only the basic remain)
• All stats associated to videoProgress are removed
• Some stats associated to videoTimeRange are removed: uniqueusersstreams, allclicks, clicks, uniqueusersallclicks (rest of those are available now in GetVideoStatNames command)

Interface changes

From now on, new and active campaigns will be calculated by new video modul in a faster and more efficient way. Therefore with this we present new video statistics in the interface. Please be aware that new recalculated video stats may differ from those calculated from old video module (before release).

Please note: due to the different time of calculating statistics between video and basic (in the summary tab), there will be moments when they will differ during duration of the campaign.

We introduce further changes:

Removed few statistics from video section

In video statistic section there is no clicks, viewers and plays stats, you will be able to check them under summary tab accordingly as: clicks, reach, impressions.

Interaction distribution chart

Within our new release, we add interaction distribution chart on which data will be shown when appropriate macros are used on the implementation side. Documentation with implementation details will be available soon.

Cross-campaign reports section

Also for each video statistic there is an infomation: "Beware that the data for this statistic has a granularity of full hours, which may impact included data for the selected start and end times" in Cross-campaign reports section 

Period reports changes

There are some changes in period reports for video section:

• no support for Placement category and Creative's category columns
  
• It do not return rows with only 0s
• order's progress in video statistics is returned only for orders with planning over video ends
• order's progress in basic statistics is not returned for orders with planning over video ends

New Video view through rate statistic

The last feature also comes with new Video view through rate statistic which is the ratio of the number of Video Ends to the number of Video Starts (Video Ends / Video Starts, takes value from 100% to 0%, in API takes value between 0 and 1)

api interface