Indicators
GetIndicatorsList [finished]
Overlays:
Activation:
GetIndicatorsList.php ? sessionID = ...
[ & userID = ... ]
[ & timeDivision = ... ]
[ & dimensionIDs = ... ]
[ & filterDimensionIDs = ... ]
[ & groupIDs = ... ]
[ & filterGroupIDs = ... ]
[ & timeUnitFilter = ... ]
[ & aggregationFunc = ... ]
[ & aggregationUnit = ... ]
[ & reportModuleID = ... ]
[ & showPossible = ... ]
[ & groupByIDs = ... ]
[ & groupConnectionFilterIDs = ... ]
[ & highlightGroupID = ... ]
[ & namePattern = ... ]
[ & campaignIDs = ... ]
[ & filteredReportID = ... ]
[ & timeDivision = ... ]
[ & techDimension = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns a list of indicators available for the current user. Output can be grouped into tree with groupByIDs parameter.
Parameters:
- sessionID: string(16)
- userID: uint - prepares list of indicators available for the given user
- timeDivision: enum('General', 'Month', 'Week', 'Day', 'Hour') - only indicators available for given time intervals division
- dimensionIDs: uint list - only indicators available for given statistic dimensions intersection
- filterDimensionIDs: uint list - only indicators available for given statistic dimensions filter
- groupIDs: uint list - result is the sum of the given groups of indicators
- filterGroupIDs: uint list - result is intersected with the given groups of indicators
- timeUnitFilter: uint list - whether parameters lowerTimeUnit/upperTimeUnit/timeUnits will be used in GetStats command
- aggregationFunc: enum('Sum', 'Avg') - only indicators available for given aggregation function
- aggregationUnit: enum(General, Month, Week, Day, Hour, WeekDay, DayHour) - only indicators available for given aggregation unit
- reportModuleID: uint - returns indicators available for given report module
- showPossible: enum('Y', 'N') - returns indicators which can be assigned to user
- groupByIDs: uint list - list of indicator group labels, in order that grouping have to be performed (makes use of group connections)
- groupConnectionFilterIDs: nullable uint list - list of the same length as groupByIDs. Group filter inside the label. There will be returned only groups with connectedGroupIDs containing given value.
- highlightGroupID: uint - indicator group determining priorities of indicators (results in highlighted flag set to Y or N)
- namePattern: string - filter for the names of indicators
- campaignIDs: uint list - returns only indicators available for the given campaigns
- filteredReportID: uint list - returns only indicators available for the given filtered reports
- timeDivision: enum('General', 'Month', 'Week', 'Day', 'Hour')
- techDimension: enum('Country', 'Region', 'City', 'Browser', 'BrowserVersion', 'System', 'SystemGroup')
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetIndicatorsList>
<status>OK</status>
<indicatorsNumber>4</indicatorsNumber> : uint - all records number (if there were no limit and offset)
<indicators>
<indicator>
<indicatorID>1</indicatorID> : uint
<groupIDs>1</groupIDs> : uint list - all groups that indicator belongs to
<name>successfulClicks</name> : string(63)
<expression>I(4) - 2 * I(12)</expression> : string(255) - only for custom indicators
<ratioIndicatorID>75</ratioIndicatorID> : nullable uint - indicator containing information about ratio (single range/total)
<mainIndicatorID>75</mainIndicatorID> : nullable uint - access to indicator is granted by granting access to main indicator
<comments>sth</comments> : string(255)
<isUsed>Y</isUsed> : enum('Y', 'N') - whether there exists any custom indicator created on the basis of this one
<valueType>uint</valueType> : enum('uint', 'float', 'percent')
<allowed>N</allowed> : enum('Y', 'N') - whether access to indicator is granted to user (only when showPossible = 'Y')
<highlighted>Y</highlighted> : enum('Y', 'N') - whether indicator has high priority in given highlight group
</indicator>
</indicators>
</GetIndicatorsList>
Throw Errors:
GetIndicatorDimensionsList [finished]
Overlays:
Activation:
GetIndicatorDimensionsList.php ? sessionID = ...
[ & groupID = ... ]
[ & types = ... ]
Description:
Returns a list of indicator dimensions (eg. Placement, Creative).
Statistics are available for all intersections of them. However,
reach statistics are available only for some predefined intersections.
Parameters:
- sessionID: string(16)
- groupID: uint
- types: enum('basic', 'technical', 'xcampaign', 'partial') list - filter for dimension type
Results:
<GetIndicatorDimensionsList>
<status>OK</status>
<dimensionsNumber>2</dimensionsNumber> : uint - records number
<dimensions>
<dimension>
<dimensionID>1</dimensionID> : uint
<name>Campaign</name> : string(100)
<type>basic</type> : enum('basic', 'technical', 'xcampaign', 'partial')
</dimension>
<dimension>
<dimensionID>20</dimensionID>
<name>Placement</name>
<type>basic</type>
</dimension>
</dimensions>
</GetIndicatorDimensionsList>
Throw Errors:
GetIndicatorGroupsList [finished]
Overlays:
Activation:
GetIndicatorGroupsList.php ? sessionID = ...
[ & groupIDs = ... ]
[ & connectedGroupIDs = ... ]
[ & campaignIDs = ... ]
[ & labelIDs = ... ]
Description:
Returns a list of indicator groups. Several indicators can belong to any number of groups.
Parameters:
- sessionID: string(16)
- groupIDs: uint list - returns only requested groups data
- connectedGroupIDs: uint list - returns only groups connected with given
- campaignIDs: uint list - returns only groups containing indicators available for the given campaign
- labelIDs: uint list - returns only groups with given labels
Results:
<GetIndicatorGroupsList>
<status>OK</status>
<groupsNumber>3</groupsNumber> : uint - records number
<groups>
<group>
<groupID>1</groupID> : uint
<name>User clicks</name> : string(63)
</group>
<group>
<groupID>2</groupID> : uint
<name>Additive</name> : string(63)
</group>
<group>
<groupID>3</groupID> : uint
<name>Custom</name> : string(63)
</group>
</groups>
</GetIndicatorGroupsList>
Throw Errors:
GetIndicatorGroupLabelsList [finished]
Overlays:
Activation:
GetIndicatorGroupLabelsList.php ? sessionID = ...
Description:
Returns a list of indicator group labels.
Parameters:
- sessionID: string(16)
Results:
<GetIndicatorGroupLabelsList>
<status>OK</status>
<labelsNumber>3</labelsNumber> : uint - records number
<labels>
<label>
<labelID>1</labelID> : uint
<name>View</name> : string(63)
</label>
<label>
<labelID>2</labelID> : uint
<name>Family</name> : string(63)
</label>
<label>
<labelID>3</labelID> : uint
<name>Clan</name> : string(63)
</label>
</labels>
</GetIndicatorGroupLabelsList>