Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current ·  View Page History

Each report has its own set of parameters, specific to the nature of each one. However, many are common between all reports.

The parameters for each report are now summarised over the next few pages for your convenience.

COMMON PARAMETERS
Parameter Description Default value
period * Report period
fromdate * From date
todate * To date
fromtime From time
totime To time
name Report title
width Width of results table (% is provided) 100
site Site to report on Blank implies all sites
CUSTOM REPORT (1)
Parameter Description Default value
type Specifies call type from:
'outgoing' or 'all outgoing calls'
'outgoingx' or 'outgoing transfers'
'incoming' or 'all incoming calls'
'answered' or 'answered calls'
'answeredx' or 'answered transfers'
'abandoned' or 'abandoned calls'
'abandonedx' or 'abandoned transfers'
'internal' or 'internal calls'
'feature' or 'pbx feature calls'
Blank implies all call types
fromdurn Duration range start
todurn Duration range end
fromresponse Response time range start
toresponse Response time range end
extension Extension number
fromextn Extension number range start
toextn Extension number range end
extname Extension name
extngroup Extension group
trunk Trunk number
fromtrunk Trunk number range start
totrunk Trunk number range end
trunkname Trunk name
trunkgroup Trunk group
account ** Account code match
cli ** Caller ID match
accesscode Specifies a trunk access code (eg. 9)
lcr Specifies a Least Cost Route sequence
diallednumber ** Dialled number match
destination ** Location name match
tariff ** Tariff name match
fromcost Cost range start
tocost Cost range end
orderby Specifies field to order result by, from: 'site', 'datetime', 'date', 'time', 'type', 'duration', 'response', 'dayminute', 'dayhalfhour', 'extension', 'extensionname', 'extensiongroup', 'trunk', 'trunkname', 'trunkgroup', 'account', 'cli', 'accesscode', 'lcr', 'diallednumber', 'destination', 'tariff', or 'cost'
sort Specifies direction of sort 'up' or 'down' where 'up' specifies ascending, etc up
BILLING REPORT (2)
Parameter Description Default value
extngroup * Extension Group name
extension * Extension number
accountcode * Account code
markup Markup per call (% is provided) 0
surcharge Surcharge per call (no currency symbol) 0
ORGANISATION DRILL-DOWN (3)
Parameter Description Default value
extngroup Extension Group name
live True or False - enables/disables hyperlinks false
TRUNKS BUSY (4)
Parameter Description Default value
trunkgroup Trunk group
trunk Trunk number
diallednumber ** Dialled number 0
destination ** Destination/Place name
CALL GEOGRAPHY ANALYSIS (5)
Parameter Description Default value
extension Extension number
extngroup Extension group
trunk Trunk number
trunkgroup Trunk group
TOP X CALLS REPORT (6)
Parameter Description Default value
incomingonly True or False - specifies incoming calls only
outgoingonly True or False - specifies outgoing calls only
extension Extension number
extngroup Extension group
order 'duration' or 'cost' cost
topx Topmost number of calls from selection 50
live True or False - enables/disables hyperlinks false
INCOMING CALL ANALYSIS (7)
Parameter Description Default value
extension Extension number
extngroup Extension group
trunk Trunk number
trunkgroup Trunk group
noxfers True or False - includes or excludes transferred calls
rowheight Specifies height of each row in table 18
daystart Specifies starting half-hour of working day 15
dayend Specifies ending half-hour of working day 37
coldaylight Colour RRGGBB of daytime's light shade FFFFEC
coldaydark Colour RRGGBB of daytime's dark shade FFD7C4
colnightlight Colour RRGGBB of night-time's light shade F0F0FF
colnightdark Colour RRGGBB of night-time's dark shade E0E0FF
reversehours True or False - True specifies 00:00 at top of report, to 23:59 at bottom false
viewstart Starting half-hour of view (ignores earlier) 1
viewend Ending half-hour of view (ignores later) 48
FREQUENT NUMBERS (8)
Parameter Description Default value
diallednumber ** Specifies dialled digits
extngroup Extension group
minfrequency Specifies minimum frequency of a dialled number to feature in the results 2
orderby Specifies order of results, either 'number of calls', 'duration', 'cost' cost

* Indicates a mandatory field.

** It is provided.

 

 

 

Labels: