Basic Stats
GetBasicStats [finished]
Overlays:
Activation:
GetBasicStats.php ? sessionID = ... & dimensionIDs = ... & indicatorIDs = ... & timeDivision = ...
(& campaignIDs = ... | & filteredReportID = ... )
[ & campaignActionIDs = ... ]
[ & publisherIDs = ... ]
[ & placementIDs = ... ]
[ & placementCategoryIDs = ... ]
[ & placementTouchPointIDs = ... ]
[ & placementTag1IDs = ... ]
[ & placementTag2IDs = ... ]
[ & withPlacementRoots = ... ]
[ & placementPrintMode = ... ]
[ & orderIDs = ... ]
[ & creativeIDs = ... ]
[ & creativeCodeIDs = ... ]
[ & creativeFormIDs = ... ]
[ & creativeTypeIDs = ... ]
[ & creativeEventIDs = ... ]
[ & creativeClickTagIDs = ... ]
[ & creativeTag1IDs = ... ]
[ & creativeTag2IDs = ... ]
[ & actionPathIDs = ... ]
[ & attributeIDs = ... ]
[ & attributeValuesLimit = ... ]
[ & targetGroupIDs = ... ]
[ & socDemDivision = ... ]
[ & aggregationFunc = ...
(& aggregationUnit = ... | & aggregationDimensionIDs = ...) ]
( & timeUnits = ... |
[ & lowerTimeUnit = ... ]
[ & upperTimeUnit = ... ] )
[ & showNames = ... ]
[ & humanDates = ... ]
[ & indicatorNames = ... ]
[ & sortDimensionIDs = ... & dimensionSortOrders = ... ]
[ & sortIndicatorIDs = ... & indicatorSortOrders = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns basic statistics for the given campaigns.
Output format may vary depending on the input parameters.
All sensible dimension intersections are available.
See Indicators->GetIndicatorDimensionsList.
Indicators from groups basicGeneral and basicNonGeneral are available
for this command. See Indicators->GetIndicatorsList.
Time units are in format YYYYMMDDHHmmss, e.g. 20110302150000.
Object filters do not require specific dimensions passed. However, in some
configurations, adding such a filters results in unavailability of reach statistics.
Publishers do not see statistics for placement nodes.
Parameters:
- sessionID: string(16)
- dimensionIDs: uint list - list of indicator dimensions to intersect, they will appear in output
- indicatorIDs: uint list - list of indicators (only basic indicators are allowed)
- campaignIDs: uint list - max 40 campaigns
- filteredReportID: uint
- campaignActionIDs: uint list - actions are available only in General time division
- publisherIDs: uint list - filter for specific publishers
- placementIDs: uint list - filter for specific placements
- placementCategoryIDs: uint list - filter for specific categories
- placementTouchPointIDs: uint list - filter for specific touch points
- placementTag1IDs: uint list - filter for specific tags
- placementTag2IDs: uint list - filter for specific tags
- withPlacementRoots: enum('Y',N') default 'Y' - show records for campaign root placements
- placementPrintMode: enum('all','nodes','leaves') default 'all' - whether to show placements, folders or either placements and folders in output
- orderIDs: uint list - filter for specific orders
- creativeIDs: uint list - filter for specific creatives
- creativeCodeIDs: uint list - filter for specific creative codes
- creativeFormIDs: uint list - filter for specific creative forms
- creativeTypeIDs: uint list - filter for specific creative types
- creativeEventIDs: uint list - filter for specific interactions
- creativeClickTagIDs: uint list - filter for specific click tags
- creativeTag1IDs: uint list - filter for specific tags
- creativeTag2IDs: uint list - filter for specific tags
- actionPathIDs: uint list - filter for action paths
- attributeIDs: uint list - filter for socio-demography attributes
- attributeValuesLimit: uint - only the given number of socio-demography vaules will be displayed for each attribute
- targetGroupIDs: uint list - filter for socio-demography target groups
- socDemDivision: enum('Attribute','TargetGroup') - which socio-demography stats will be displayed: per attribute or per target group
- timeDivision: enum('General','Month','Week','Day','Hour') @ - statsTimeDivision@
- aggregationFunc: enum('Avg','Sum') - aggregates some period, e.g. average number of clicks in week (only in General time division)
- aggregationUnit: enum('Week','Day','Hour','WeekDay','DayHour') - period to aggregate
- aggregationDimensionIDs: uint list - group result by these dimensions
- timeUnits: timeunit list - list of statistic time units
- lowerTimeUnit: timeunit - lower limit for statistic time units
- upperTimeUnit: timeunit - upper limit for statistic time units
- showNames: enum('Y','N') default 'N' - if enabled, names of objects in the result will be printed
- humanDates: enum('Y','N') default 'N'
- indicatorNames: enum('Y','N') default 'Y' - if enabled, statistic value will be surrounded by XML tag containing indicator name. Otherwise, tag will be named using indicator id (e.g. <indicatorID_3>34</indicatorID_3>).
- sortDimensionIDs: uint list - list od indicator dimensions, that will be used to sort records (eg. placement names), must be subset of dimensionIDs
- dimensionSortOrders: enum('asc','desc') list
- sortIndicatorIDs: uint list - list of indicators, that will be used to sort records, must be subset of indicatorIDs
- indicatorSortOrders: enum('asc','desc') list - orders of indicator sorting, list must have the same length as sortIndicatorIDs
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetBasicStats>
<status>OK</status>
<statisticsNumber>100</statisticsNumber> : uint - all records number (if there were no limit and offset)
<statistics>
<statisticsRecord>
<campaignID>14771</campaignID> : uint
<placementID>4005330</placementID> : nullable uint
<periodName>Month</periodName> : string
<period>20100501000000</period> : uint/timeunit - period in time unit or unix timestamp format
<clicks>42741</clicks> : nullable float - statistic value
<impressions>178419</impressions> : nullable float - statistic value
</statisticsRecord>
</statistics>
</GetBasicStats>
Throw Errors:
GetFreqStats [finished]
Overlays:
Activation:
GetFreqStats.php ? sessionID = ... & dimensionIDs = ... & indicatorIDs = ...
( & campaignIDs = ... | & filteredReportID = ... )
[ & publisherIDs = ... ]
[ & placementIDs = ... ]
[ & placementCategoryIDs = ... ]
[ & placementTouchPointIDs = ... ]
[ & placementTag1IDs = ... ]
[ & placementTag2IDs = ... ]
[ & withPlacementRoots = ... ]
[ & placementPrintMode = ... ]
[ & orderIDs = ... ]
[ & creativeIDs = ... ]
[ & creativeCodeIDs = ... ]
[ & creativeFormIDs = ... ]
[ & creativeTypeIDs = ... ]
[ & creativeEventIDs = ... ]
[ & creativeClickTagIDs = ... ]
[ & creativeTag1IDs = ... ]
[ & creativeTag2IDs = ... ]
[ & showNames = ... ]
[ & humanDates = ... ]
[ & indicatorNames = ... ]
[ & sortDimensionIDs = ... & dimensionSortOrders = ... ]
[ & sortIndicatorIDs = ... & indicatorSortOrders = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns frequency statistics for the given campaigns.
Output format may vary depending on the input parameters.
Statistics are available only for some predefined intersections.
See Indicators->GetIndicatorDimensionsList.
Indicators from groups frequencyClicks and frequencyImpressions are available
for this command. See Indicators->GetIndicatorsList.
Statistics are available in General time division.
Time units are in format YYYYMMDDHHmmss, e.g. 20110302150000.
Object filters do not require specific dimensions passed. However, in some
configurations, adding such a filters results in unavailability of reach statistics.
Publishers do not see statistics for placement nodes.
Parameters:
- sessionID: string(16)
- dimensionIDs: uint list - list of indicator dimensions to intersect, they will appear in output
- indicatorIDs: uint list - list of indicators (only basic indicators are allowed)
- campaignIDs: uint list - max 40 campaigns
- filteredReportID: uint
- publisherIDs: uint list - filter for specific publishers
- placementIDs: uint list - filter for specific placements
- placementCategoryIDs: uint list - filter for specific categories
- placementTouchPointIDs: uint list - filter for specific touch points
- placementTag1IDs: uint list - filter for specific tags
- placementTag2IDs: uint list - filter for specific tags
- withPlacementRoots: enum('Y',N') default 'Y' - show records for campaign root placements
- placementPrintMode: enum('all','nodes','leaves') default 'all' @ - statsPlacementPrintMode@
- orderIDs: uint list - filter for specific orders
- creativeIDs: uint list - filter for specific creatives
- creativeCodeIDs: uint list - filter for specific creative codes
- creativeFormIDs: uint list - filter for specific creative forms
- creativeTypeIDs: uint list - filter for specific creative types
- creativeEventIDs: uint list - filter for specific creative events
- creativeClickTagIDs: uint list - filter for specific creative click tags
- creativeTag1IDs: uint list - filter for specific tags
- creativeTag2IDs: uint list - filter for specific tags
- showNames: enum('Y','N') default 'N' - if enabled, names of objects in the result will be printed
- humanDates: enum('Y','N') default 'N'
- indicatorNames: enum('Y','N') default 'Y' - if enabled, statistic value will be surrounded by XML tag containing indicator name. Otherwise, tag will be named using indicator id (e.g. <indicatorID_3>34</indicatorID_3>).
- sortDimensionIDs: uint list - list od indicator dimensions, that will be used to sort records (eg. placement names), must be subset of dimensionIDs
- dimensionSortOrders: enum('asc','desc') list
- sortIndicatorIDs: uint list - list of indicators, that will be used to sort records, must be subset of indicatorIDs
- indicatorSortOrders: enum('asc','desc') list - orders of indicator sorting, list must have the same length as sortIndicatorIDs
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetFreqStats>
<status>OK</status>
<statisticsNumber>260</statisticsNumber> : uint - all records number (if there were no limit and offset)
<statistics>
<statisticsRecord>
<campaignID>14771</campaignID> : uint
<placementID>4005330</placementID> : nullable uint
<range>1</range> : string - range of events number performed by single user
<freqImpressionsReach>1278</freqImpressionsReach> : nullable float - statistic value
<freqImpressionsUCTR>0.014085</freqImpressionsUCTR> : nullable float - statistic value
</statisticsRecord>
<statisticsRecord>
<campaignID>14771</campaignID> : uint
<placementID>4005330</placementID> : nullable uint
<range>6-10</range> : string - range of events number performed by single user
<freqImpressionsReach>262</freqImpressionsReach> : nullable float - statistic value
<freqImpressionsUCTR>0.141221</freqImpressionsUCTR> : nullable float - statistic value
</statisticsRecord>
</statistics>
</GetFreqStats>
Throw Errors:
GetTechStats [finished]
Overlays:
Activation:
GetTechStats.php ? sessionID = ... & dimensionIDs = ... & indicatorIDs = ... & techDimension = ...
( & campaignIDs = ... | & filteredReportID = ... )
[ & publisherIDs = ... ]
[ & placementIDs = ... ]
[ & placementCategoryIDs = ... ]
[ & placementTouchPointIDs = ... ]
[ & placementTag1IDs = ... ]
[ & placementTag2IDs = ... ]
[ & withPlacementRoots = ... ]
[ & placementPrintMode = ... ]
[ & orderIDs = ... ]
[ & creativeIDs = ... ]
[ & creativeCodeIDs = ... ]
[ & creativeFormIDs = ... ]
[ & creativeTypeIDs = ... ]
[ & creativeEventIDs = ... ]
[ & creativeClickTagIDs = ... ]
[ & creativeTag1IDs = ... ]
[ & creativeTag2IDs = ... ]
[ & countryIDs = ... ]
[ & regionIDs = ... ]
[ & cityIDs = ... ]
[ & browserIDs = ... ]
[ & browserVersionIDs = ... ]
[ & systemIDs = ... ]
[ & systemGroupIDs = ... ]
[ & summary = ... ]
[ & summaryCountryID = ... ]
( & aggregationFunc = ... & aggregationDimensionIDs = ... )
[ & showNames = ... ]
[ & humanDates = ... ]
[ & indicatorNames = ... ]
[ & sortDimensionIDs = ... & dimensionSortOrders = ... ]
[ & sortIndicatorIDs = ... & indicatorSortOrders = ... ]
[ & langID = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns technical statistics for the given campaigns.
Output format may vary depending on the input parameters.
All sensible dimension intersections are available.
See Indicators->GetIndicatorDimensionsList.
Indicators from tech group are available for this command.
See Indicators->GetIndicatorsList.
Statistics are available in General time division.
Time units are in format YYYYMMDDHHmmss, e.g. 20110302150000.Object filters do not require specific dimensions passed. However, in some
configurations, adding such a filters results in unavailability of reach statistics.
Object filters do not require specific dimensions passed. However, in some
configurations, adding such a filters results in unavailability of reach statistics.
Publishers do not see statistics for placement nodes.
Parameters:
- sessionID: string(16)
- dimensionIDs: uint list - list of indicator dimensions to intersect, they will appear in output
- indicatorIDs: uint list - list of indicators (only tech indicators are allowed)
- techDimension: enum('Country','Region','City', 'Browser','BrowserVersion', 'System','SystemGroup') - technical domain name
- campaignIDs: uint list - max 40 campaigns
- filteredReportID: uint
- publisherIDs: uint list - filter for specific publishers
- placementIDs: uint list - filter for specific placements
- placementCategoryIDs: uint list - filter for specific categories
- placementTouchPointIDs: uint list - filter for specific touch points
- placementTag1IDs: uint list - filter for specific tags
- placementTag2IDs: uint list - filter for specific tags
- withPlacementRoots: enum('Y',N') default 'Y' - show records for campaign root placements
- placementPrintMode: enum('all','nodes','leaves') default 'all' - whether to show placements, folders or either placements and folders in output
- orderIDs: uint list - filter for specific orders
- creativeIDs: uint list - filter for specific creatives
- creativeCodeIDs: uint list - filter for specific creative codes
- creativeFormIDs: uint list - filter for specific creative forms
- creativeTypeIDs: uint list - filter for specific creative types
- creativeEventIDs: uint list - filter for specific interactions
- creativeClickTagIDs: uint list - filter for specific click tags
- creativeTag1IDs: uint list - filter for specific tags
- creativeTag2IDs: uint list - filter for specific tags
- countryIDs: uint list - filter for specific countries
- regionIDs: uint list - filter for specific regions
- cityIDs: uint list - filter for specific cities
- browserIDs: uint list - filter for specific browsers
- browserVersionIDs: uint list - filter for specific browser versions
- systemIDs: uint list - filter for specific systems
- systemGroupIDs: uint list - filter for specific system groups
- aggregationFunc: enum('Avg','Sum') - aggregates some period, e.g. sum by placements
- aggregationDimensionIDs: uint list - group result by these dimensions
- showNames: enum('Y','N') default 'N' - if enabled, names of objects in the result will be printed
- humanDates: enum('Y','N') default 'N'
- indicatorNames: enum('Y','N') default 'Y' - if enabled, statistic value will be surrounded by XML tag containing indicator name. Otherwise, tag will be named using indicator id (e.g. <indicatorID_3>34</indicatorID_3>).
- sortDimensionIDs: uint list - list od indicator dimensions, that will be used to sort records (eg. placement names), must be subset of dimensionIDs
- dimensionSortOrders: enum('asc','desc') list
- sortIndicatorIDs: uint list - list of indicators, that will be used to sort records, must be subset of indicatorIDs
- indicatorSortOrders: enum('asc','desc') list - orders of indicator sorting, list must have the same length as sortIndicatorIDs
- langID: uint - language, the object (eg. country) names will be printed in
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetTechStats>
<status>OK</status>
<statisticsNumber>260</statisticsNumber> : uint - all records number (if there were no limit and offset)
<statistics>
<statisticsRecord>
<campaignID>14771</campaignID> : uint
<placementID>4005331</placementID> : nullable uint
<countryID>42</countryID> : nullable uint
<regionID>1</regionID> : nullable uint
<clicks>592</clicks> : nullable float - statistic value
<impressions>2134</impressions> : nullable float - statistic value
</statisticsRecord>
</statistics>
</GetTechStats>
Throw Errors:
GetTimeRangeStats [finished]
Overlays:
Activation:
GetTimeRangeStats.php ? sessionID = ... & dimensionIDs = ... & indicatorIDs = ...
( & campaignIDs = ... | & filteredReportID = ... )
[ & publisherIDs = ... ]
[ & placementIDs = ... ]
[ & placementCategoryIDs = ... ]
[ & placementTouchPointIDs = ... ]
[ & placementTag1IDs = ... ]
[ & placementTag2IDs = ... ]
[ & withPlacementRoots = ... ]
[ & placementPrintMode = ... ]
[ & orderIDs = ... ]
[ & creativeIDs = ... ]
[ & creativeCodeIDs = ... ]
[ & creativeFormIDs = ... ]
[ & creativeTypeIDs = ... ]
[ & creativeEventIDs = ... ]
[ & creativeClickTagIDs = ... ]
[ & creativeTag1IDs = ... ]
[ & creativeTag2IDs = ... ]
[ & showNames = ... ]
[ & humanDates = ... ]
[ & indicatorNames = ... ]
[ & sortDimensionIDs = ... & dimensionSortOrders = ... ]
[ & sortIndicatorIDs = ... & indicatorSortOrders = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns technical statistics for the given campaigns.
Output format may vary depending on the input parameters.
All sensible dimension intersections are available.
See Indicators->GetIndicatorDimensionsList.
Indicators from groups timeRangeInteractions, timeRangeClicks and timeRangeActions
are available for this command. In single request there can appear only indicators
from one of these groups. See Indicators->GetIndicatorsList.
There can be different ranges in output for different indicators.
Statistics are available in General time division.
Time units are in format YYYYMMDDHHmmss, e.g. 20110302150000.
Object filters do not require specific dimensions passed. However, in some
configurations, adding such a filters results in unavailability of reach statistics.
Publishers do not see statistics for placement nodes.
Parameters:
- sessionID: string(16)
- dimensionIDs: uint list - list of indicator dimensions to intersect, they will appear in output
- indicatorIDs: uint list - list of indicators (only tech time range indicators are allowed)
- campaignIDs: uint list - max 40 campaigns
- filteredReportID: uint
- publisherIDs: uint list - filter for specific publishers
- placementIDs: uint list - filter for specific placements
- placementCategoryIDs: uint list - filter for specific categories
- placementTouchPointIDs: uint list - filter for specific touch points
- placementTag1IDs: uint list - filter for specific tags
- placementTag2IDs: uint list - filter for specific tags
- withPlacementRoots: enum('Y',N') default 'Y' - show records for campaign root placements
- placementPrintMode: enum('all','nodes','leaves') default 'all' - whether to show placements, folders or either placements and folders in output
- orderIDs: uint list - filter for specific orders
- creativeIDs: uint list - filter for specific creatives
- creativeCodeIDs: uint list - filter for specific creative codes
- creativeFormIDs: uint list - filter for specific creative forms
- creativeTypeIDs: uint list - filter for specific creative types
- creativeEventIDs: uint list - filter for specific interactions
- creativeClickTagIDs: uint list - filter for specific click tags
- creativeTag1IDs: uint list - filter for specific tags
- creativeTag2IDs: uint list - filter for specific tags
- showNames: enum('Y','N') default 'N' - if enabled, names of objects in the result will be printed
- humanDates: enum('Y','N') default 'N'
- indicatorNames: enum('Y','N') default 'Y' - if enabled, statistic value will be surrounded by XML tag containing indicator name. Otherwise, tag will be named using indicator id (e.g. <indicatorID_3>34</indicatorID_3>).
- sortDimensionIDs: uint list - list od indicator dimensions, that will be used to sort records (eg. placement names), must be subset of dimensionIDs
- dimensionSortOrders: enum('asc','desc') list
- sortIndicatorIDs: uint list - list of indicators, that will be used to sort records, must be subset of indicatorIDs
- indicatorSortOrders: enum('asc','desc') list - orders of indicator sorting, list must have the same length as sortIndicatorIDs
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetTimeRangeStats>
<status>OK</status>
<statisticsNumber>260</statisticsNumber> : uint - all records number (if there were no limit and offset)
<statistics>
<statisticsRecord>
<campaignID>14771</campaignID> : uint
<placementID>4005330</placementID> : nullable uint
<range>0-5</range> : string - time range, in which events are calculated (starting from the impression time)
<timeRangeClicks>2713</timeRangeClicks> : nullable float - statistic value
<timeRangeUserClicks>1857</timeRangeUserClicks> : nullable float - statistic value
</statisticsRecord>
</statistics>
</GetTimeRangeStats>
Throw Errors:
GetOnlineStats [finished]
Overlays:
Activation:
GetOnlineStats.php ? sessionID = ... & dimensionIDs = ... & indicatorIDs = ... & timeDivision = ... & campaignIDs = ...
[ & orderIDs = ... ]
[ & creativeIDs = ... ]
[ & placementIDs = ... ]
[ & withPlacementRoots = ... ]
[ & showNames = ... ]
[ & humanDates = ... ]
[ & indicatorNames = ... ]
[ & lowerTimeUnit = ... ]
[ & upperTimeUnit = ... ]
[ & sortIndicatorID = ... & sortOrder = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns online (updated in real time) statistics for the given campaigns.
Output format may vary depending on the input parameters.
Available dimension intersections are:
- campaign,
- creative,
- placement,
- order,
- creative × placement,
- creative × order.
See Indicators->GetIndicatorDimensionsList.
Available indicators are:
- clicks
- impressions
Time units are in format YYYYMMDDHHmmss, e.g. 20110302150000.
Publishers do not see statistics for placement nodes.
Parameters:
- sessionID: string(16)
- dimensionIDs: uint list - list of indicator dimensions to intersect, they will appear in output
- indicatorIDs: uint list - list of indicators (only clicks and impressions are allowed)
- timeDivision: enum('General','Month','Week','Day','Hour') - name of a time period for which statistics will be displayed
- campaignIDs: uint list - max 40 campaigns
- orderIDs: uint list - filter for specific orders, only if Order dimension is selected
- creativeIDs: uint list - filter for specific creatives, only if Creative dimension is selected
- placementIDs: uint list - filter for specific placements, only if Placement dimension is selected
- withPlacementRoots: enum('Y',N') - default 'Y' : @:statsWithPlacementRoots@
- showNames: enum('Y','N') default 'N' - if enabled, names of objects in the result will be printed
- humanDates: enum('Y','N') - default 'N' : @:statsHumanDates@
- indicatorNames: enum('Y','N') default 'Y' - if enabled, statistic value will be surrounded by XML tag containing indicator name. Otherwise, tag will be named using indicator id (e.g. <indicatorID_3>34</indicatorID_3>).
- lowerTimeUnit: timeunit - lower limit for statistic time units
- upperTimeUnit: timeunit - upper limit for statistic time units
- sortIndicatorID: uint - indicator, that will be used to sort records, must be element of indicatorIDs
- sortOrder: enum('asc','desc') - order of indicator sorting
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetOnlineStats>
<status>OK</status>
<campaignIDs>14771,356</campaignIDs> : uint list - list of campaigns in result
<statisticTimeUnits>20100519122354,20100303155312</statisticTimeUnits> : uint/timeunit list - list of dates, statistics are calculated to
<statistics>
<statisticsRecord>
<campaignID>14771</campaignID> : uint
<placementID>4005335</placementID> : uint
<periodName>Hour</periodName> : string
<period>20100519120000</period> : uint/timeunit - period in time unit or unix timestamp format
<clicks>2</clicks> : uint64 - statistic value
<impressions>23</impressions> : uint64 - statistic value
<online>Y</online> : enum('Y','N') - whether statistic record was updated with hit collector online data
</statisticsRecord>
</statistics>
</GetOnlineStats>