Reports API Version 2 Metrics
Introduction
The metrics section of the report API allows you to access pre-aggregated metrics data.
Grouping Metrics
Each of the metric reports listed here allows you to group, filter and sort by one or more of the following fields,
as well as any field relevant to the report (e.g. ch
for the channel metrics).
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- metricHourQuarter (int) - The quarter of the hour (between 1-4)
Not all of these fields are available in all reports, but where they exist their behaviour is similar. If you include one of these fields in the group parameter of your request, it will be included in the response. Any of these fields not included in the group parameter will not be included in the response.
If you group by the metricMonth field you will also get metricMonthName in your output. This field is appended after metricMonth is processed, and cannot itself be used to filter, sort or group.
- metricMonthName (string) - Metric month name (e.g. “January”, “February”, …)
Attribution
Attribution allows you to report on call and goal data in different ways, depending on the marketing channels and sources that bring visitors to your web site. The parameters that control attribution within reports are detailed below but for general information on attribution within the Infinity platform, please refer to our Knowledge Base article.
Attribution Models
Some reports allow you to choose an attributionModelId, which defaults to zero for the “Last Click (Absolute)” model. Using a different attribution model in your reports allows you to see the effect of multiple touchpoints in visitor journeys, by attributing part or all of each goal to one or more of the marketing channels that the visitor engaged with.
Channel Metrics
This report provides trigger data aggregated to channel level.
Request:
GET Params
- igrp (int) - IGRP to get metrics for.
- rootOrgId (int) OPTIONAL - Filter Segments accessible by an organisation.
- sort (array) - One or more sorts, see Sort Types.
- group (array) - One or more groups, see Group Types.
- limit (int) OPTIONAL - Limit result set, see Pagination.
- offset (int) OPTIONAL - Offset result set, see Pagination.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- startDate (string) - Start Date to filter by, see Dates and Timezones.
- endDate (string) - End Date to filter by, see Dates and Timezones.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
- customMetrics (array) OPTIONAL - List of customMetrics fields to show, see Custom Metrics.
- attributionModelId (int) OPTIONAL - Attribution Model ID to use for report, see Attribution Models.
- chType (string) OPTIONAL - Channel Type to filter by.
Group Types
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricWeekStartDate (int) - Metric week start date (formatted as yyyy-mm-dd, week begins on Sunday)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- ch (int) - Channel ID
- segment (int) - Segment ID
- segmentGroupId (int) - Segment Group ID
- goal (int) - Goal ID
- goalCurrency (string) - Goal Currency (three-letter ISO-4217 currency code)
- txc (string) - Transaction Currency (three-letter ISO-4217 currency code)
Filter Types
Same fields as Group Types, plus:
- pageCountTotal (int) - Page view count
- landCountTotal (int) - Total land count
- newLandCountTotal (int) - New land count
- returnLandCountTotal (int) - Return land count
- goalCountTotal (decimal) - Goal count
- callGoalCountTotal (decimal) - Call goal count
- onlineGoalCountTotal (decimal) - Non-call goal count, may include e.g. CRM and post-call rating goals
- callCountTotal (decimal) - All calls count
- bridgeCount (decimal) - Bridged call count
- missedCallCount (decimal) - Missed call count
- bridgePerc (decimal) - Bridged call %, calculated as 100 x bridgeCount / callCountTotal
- missedPerc (decimal) - Missed call %, calculated as 100 x missedCallCount / callCountTotal
- spiderCountTotal (int) - Spider count
- conversionPerc (decimal) - Conversion rate %, calculated as 100 x goalCountTotal / landCountTotal
- callConversionPerc (decimal) - Call conversion rate %, calculated as 100 x callGoalCountTotal / callCountTotal
- txvTotal (decimal) - Transaction value
- goalValueTotal (decimal) - Goal value
- callPciDataCheckedCount (int) - Count of calls checked for PCI data
- callPciDataFoundCount (int) - Count of calls where PCI data was found
- callSsnDataCheckedCount (int) - Count of calls checked for SSN data
- callSsnDataFoundCount (int) - Count of calls where SSN data was found
- callPiiDataCheckedCount (int) - Count of calls checked for number-based PII data
- callPiiDataFoundCount (int) - Count of calls where number-based PII data was found
Sort Types
Same fields as Filter Types
Custom Metrics
The following custom metrics can be specified See Custom Metrics for details.
Metric Fields Available:
- goalCount
- callCount
- txvTotal
- goalValueTotal
Condition Fields Available:
- goal
- goalCurrency
- txc
- ch
- segment
Response:
Returns a an aggregated metrics list based on your group settings.
Outcome Metrics
This report provides trigger data aggregated by transactional and goal value.
Request:
GET Params
- igrp (int) - IGRP to get metrics for.
- rootOrgId (int) OPTIONAL - Filter Segments accessible by an organisation.
- sort (array) - One or more sorts, see Sort Types.
- group (array) - One or more groups, see Group Types.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- limit (int) OPTIONAL - Limit result set, see Pagination.
- offset (int) OPTIONAL - Offset result set, see Pagination.
- startDate (string) - Start Date to filter by, see Dates and Timezones.
- endDate (string) - End Date to filter by, see Dates and Timezones.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
- attributionModelId (int) OPTIONAL - Attribution Model ID to use for report, see Attribution Models.
- chType (string) OPTIONAL - Channel Type to filter by.
Group Types
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricWeekStartDate (int) - Metric week start date (formatted as yyyy-mm-dd, week starts on Sunday)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- ch (int) - Channel ID
- goal (int) - Goal ID
- segment (int) - Segment ID
- segmentGroupId (int) - Segment Group ID
- dgrp (int) - DGRP ID
- act (string) - Action
- goalCurrency (string) - Goal currency (three-letter ISO-4217 currency code)
- txc (string) - Transaction currency (three-letter ISO-4217 currency code)
- title (string) - Trigger title
Filter Types
Same fields as Group Types, plus:
- triggerCount (int) - Trigger Count
- transactionValueTotal (int) - Transaction Value Total
- transactionValueAverage (int) - Transaction Value Average
- goalValueTotal (int) - Goal Value Total
- goalValueAverage (int) - Goal Value Average
Sort Types
Same fields as Filter Types
Response:
Returns a an aggregated metrics list based on your group settings.
Sources Metrics
This report provides trigger metrics aggregated to the marketing source level.
Request:
GET Params
- igrp (int) - IGRP to get metrics for.
- rootOrgId (int) OPTIONAL - Filter Segments accessible by an organisation.
- sort (array) - One or more sorts, see Sort Types.
- group (array) - One or more groups, see Group Types.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- limit (int) OPTIONAL - Limit result set, see Pagination.
- offset (int) OPTIONAL - Offset result set, see Pagination.
- startDate (string) - Start Date to filter by, see Dates and Timezones.
- endDate (string) - End Date to filter by, see Dates and Timezones.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
- customMetrics (array) OPTIONAL - List of customMetrics fields to show, see Custom Metrics.
- attributionModelId (int) OPTIONAL - Attribution Model ID to use for report, see Attribution Models.
- chType (string) OPTIONAL - Channel Type to filter by.
Group Types
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricWeekStartDate (int) - Metric week start date (formatted as yyyy-mm-dd, week begins on Sunday)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- ch (int) - Channel ID
- segment (int) - Segment ID
- segmentGroupId (int) - Segment Group ID
- ref (string) - Raw source reference
- dom (string) - Referrer Domain
- pub (string) - Publisher
- network (string) - Network
- campaign (string) - Campaign
- adGroup (string) - Ad Group
- adRef (string) - Ad Reference
- keywordRef (string) - Keyword Reference
- matchRef (string) - Match Reference (processed keyword)
- matchType (string) - Match Type
- goal (int) - Goal ID
- goalCurrency (string) - Goal Currency (three-letter ISO-4217 currency code)
- txc (string) - Transaction Currency (three-letter ISO-4217 currency code)
Filter Types
Same fields as Group Types, plus:
- landCountTotal (int) - Total land count
- newLandCountTotal (int) - New land count
- returnLandCountTotal (int) - Return land count
- goalCountTotal (decimal) - Goal count
- callGoalCountTotal (decimal) - Call goal count
- onlineGoalCountTotal (decimal) - Non-call goal count, may include e.g. CRM and post-call rating goals
- callCountTotal (decimal) - All calls count
- bridgeCount (decimal) - Bridged call count
- missedCallCount (decimal) - Missed call count
- bridgePerc (decimal) - Bridged call %, calculated as 100 x bridgeCount / callCountTotal
- missedPerc (decimal) - Missed call %, calculated as 100 x missedCallCount / callCountTotal
- spiderCountTotal (int) - Spider count
- conversionPerc (decimal) - Conversion rate %, calculated as 100 x goalCountTotal / landCountTotal
- callConversionPerc (decimal) - Call conversion rate %, calculated as 100 x callGoalCountTotal / callCountTotal
- txvTotal (decimal) - Transaction value
- goalValueTotal (decimal) - Goal value
- callPciDataCheckedCount (int) - Count of calls checked for PCI data
- callPciDataFoundCount (int) - Count of calls where PCI data was found
- callSsnDataCheckedCount (int) - Count of calls checked for SSN data
- callSsnDataFoundCount (int) - Count of calls where SSN data was found
- callPiiDataCheckedCount (int) - Count of calls checked for number-based PII data
- callPiiDataFoundCount (int) - Count of calls where number-based PII data was found
Sort Types
Same fields as Filter Types
Custom Metrics
The following custom metrics can be specified See Custom Metrics for details.
Metric Fields Available:
- goalCount
- callCount
- txvTotal
- goalValueTotal
Condition Fields Available:
- goal
- goalCurrency
- txc
- ch
- segment
Response:
Returns a an aggregated metrics list based on your group settings.
Operational Call Metrics
This report provides trigger data aggregated to operational call metrics.
Unless otherwise indicated, the count and percentage (perc) fields in this report for calls that reached a given stage, also include calls that passed through this stage. E.g. a call that was queued and then successfully bridged will show in both the queueCount and bridgeCount fields, but a call that dropped out while queueing will only show in the queueCount field.
The queueBridge fields show only those calls which both queued and bridged. Calls that were bridged directly without queueing (e.g. DDI calls) are not included.
The DailyAvg fields in this report take into account “active” days only. E.g. if a given operator only answers calls three days per week then their daily average figures will reflect that.
Request:
GET Params
- igrp (int) - IGRP to get metrics for.
- startDate (string) - Start Date to filter by, see Dates and Timezones.
- endDate (string) - End Date to filter by, see Dates and Timezones.
- chType (string) OPTIONAL - Channel Type to filter by.
- group (array) - One or more groups, see Group Types.
- limit (int) OPTIONAL - The maximum number of rows to return.
- sort (array) OPTIONAL - One or more sorts, see Sort Types.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- offset (array) OPTIONAL - The offset to apply.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
- customMetrics (array) OPTIONAL - List of customMetrics fields to show, see Custom Metrics.
Group Types
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricWeekStartDate (int) - Metric week start date (formatted as yyyy-mm-dd, week begins on Sunday)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- metricHourQuarter (int) - The quarter of the hour (between 1-4)
- dgrp (int) - DGRP ID.
- ch (int) - The channel ID.
- segment (int) - Segment ID
- segmentGroupId (int) - Segment Group ID
- ivrRef (string) - The IVR reference
- dialplanRef (string) - The dialplan reference
- callRating (string) - The call rating
- callDirection (string) - The call direction, can be one of (in or out)
- callStage (string) - The stage the call was at when it ended, can be one of (ring, ivr, queue, bridge, voicemail)
- operatorRef (string) - The operator reference
- pub (string) - The marketing publisher for the call, or in PBX IGRPs this holds the call tracking IGRP name
- queueName (string) - The name of the queue that the call was placed in
- teamName (string) - The name of the PBX team that the call was sent to
Filter Types
Same fields as Group Types*, plus:
- callCount (int) - The total number of calls
- ringCount (int) - The total number of calls that reached the ring stage
- ivrCount (int) - The total number of calls that reached the ivr stage
- queueCount (int) - The total number of calls that reached the queue stage
- bridgeCount (int) - The total number of calls that reached the bridge stage
- voicemailCount (int) - The total number of calls that reached the voicemail stage
- queueBridgeCount (float) - The total number of calls that passed through the queue stage and reached the bridge stage
- missedCallCount (int) - The number of missed calls
- callDurationTotal (int) - The total call duration
- ringDurationTotal (int) - The total ring duration
- bridgeDurationTotal (int) - The total bridge duration
- queueDurationTotal (int) - The total queue duration
- ivrDurationTotal (int) - The total ivr duration
- callCountDailyAvg (float) - The daily average number of calls
- ringCountDailyAvg (float) - The daily average number of calls that reached the ring stage
- ivrCountDailyAvg (float) - The daily average number of calls that reached the ivr stage
- queueCountDailyAvg (float) - The daily average number of calls that reached the queue stage
- bridgeCountDailyAvg (float) - The daily average number of calls that reached the bridge stage
- voicemailCountDailyAvg (float) - The daily average number of calls that reached the voicemail stage
- queueBridgeCountDailyAvg (float) - The daily average number of calls that passed through the queue stage and reached the bridge stage
- missedCallCountDailyAvg (float) - The daily average number of missed calls
- callDurationTotalDailyAvg (float) - The daily average call duration
- ringDurationTotalDailyAvg (float) - The daily average ring duration
- bridgeDurationTotalDailyAvg (float) - The daily average bridge duration
- queueDurationTotalDailyAvg (float) - The daily average queue duration
- ivrDurationTotalDailyAvg (float) - The daily average ivr duration
- queueBridgePerc (float) - The percentage of calls that passed through the queue stage and reached the bridge stage
- callDurationAverage (int) - The average call duration
- ivrDurationAverage (int) - The average ivr duration
- queueDurationAverage (int) - The average queue duration
- bridgeDurationAverage (int) - The average bridge duration
- ringPerc (float) - The percentage of calls that reached the ring stage
- ivrPerc (float) - The percentage of calls that reached the ivr stage
- queuePerc (float) - The percentage of calls that reached the queue stage
- bridgePerc (float) - The percentage of calls that reached the bridge stage
- voicemailPerc (float) - The percentage of calls that reached the voicemail stage
- callPciDataCheckedCount (int) - Count of calls checked for PCI data
- callPciDataFoundCount (int) - Count of calls where PCI data was found
- callSsnDataCheckedCount (int) - Count of calls checked for SSN data
- callSsnDataFoundCount (int) - Count of calls where SSN data was found
- callPiiDataCheckedCount (int) - Count of calls checked for PII data
- callPiiDataFoundCount (int) - Count of calls where PII data was found
Sort Types
Same fields as Filter Types and Group Types, plus:
- {Custom Metrics Field} (decimal) - Any field specified in Custom Metrics.
Custom Metrics
The following custom metrics can be specified See Custom Metrics for details.
Metric Fields Available:
- callCount
- ringCount
- ivrCount
- queueCount
- bridgeCount
- voicemailCount
- queueBridgeCount
- missedCallCount
- callDurationTotal
- ringDurationTotal
- bridgeDurationTotal
- queueDurationTotal
- ivrDurationTotal
- callCountDailyAvg
- ringCountDailyAvg
- ivrCountDailyAvg
- queueCountDailyAvg
- bridgeCountDailyAvg
- voicemailCountDailyAvg
- queueBridgeCountDailyAvg
- callDurationTotalDailyAvg
- ringDurationTotalDailyAvg
- bridgeDurationTotalDailyAvg
- missedCallCountDailyAvg
- queueDurationTotalDailyAvg
- ivrDurationTotalDailyAvg
- queueBridgePerc
- callDurationAverage
- ivrDurationAverage
- queueDurationAverage
- bridgeDurationAverage
- ringPerc
- ivrPerc
- queuePerc
- bridgePerc
- voicemailPerc
Condition Fields Available:
- dgrp
- ch
- ivrRef
- dialplanRef
- callRating
- callDirection
- callStage
- operatorRef
- pub
- queueName
- teamName
Response:
Returns a an aggregated metrics list based on your group settings.
Call Queue Time Metrics
This report provides call queue time metrics.
Request:
GET Params
- igrp (int) - IGRP to get metrics for.
- startDate (string) - Start Date to filter by, see Dates and Timezones.
- endDate (string) - End Date to filter by, see Dates and Timezones.
- chType (string) OPTIONAL - Channel Type to filter by.
- group (array) - One or more groups, see Group Types.
- limit (int) OPTIONAL - The maximum number of rows to return.
- sort (array) OPTIONAL - One or more sorts, see Sort Types.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- offset (array) OPTIONAL - The offset to apply.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
- customMetrics (array) OPTIONAL - List of customMetrics fields to show, see Custom Metrics.
Group Types
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricWeekStartDate (int) - Metric week start date (formatted as yyyy-mm-dd, week begins on Sunday)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- metricHourQuarter (int) - The quarter of the hour (between 1-4)
- dgrp (int) - DGRP ID.
- ch (int) - The channel ID.
- ivrRef (string) - The IVR reference
- dialplanRef (string) - The dialplan reference
- callRating (string) - The call rating
- callDirection (string) - The call direction, can be one of (in or out)
- callStage (string) - The stage the call was at when it ended, can be one of (ring, ivr, queue, bridge, voicemail)
- operatorRef (string) - The operator reference
- pub (string) - The marketing publisher for the call, or in PBX IGRPs this holds the call tracking IGRP name
- queueName (string) - The name of the queue that the call was placed in
- teamName (string) - The name of the PBX team that the call was sent to
- queueBand (string) - The queue time band that the call falls into, e.g. ‘LE15s’ for calls queued less than 15s, ‘LE30s’, ‘LE45s’, etc.
Filter Types
Same fields as Group Types*, plus:
- callCount (int) - The total number of calls
- queueDurationMax (int) - the longest queue duration
- callPciDataCheckedCount (int) - Count of calls checked for PCI data
- callPciDataFoundCount (int) - Count of calls where PCI data was found
- callSsnDataCheckedCount (int) - Count of calls checked for SSN data
- callSsnDataFoundCount (int) - Count of calls where SSN data was found
- callPiiDataCheckedCount (int) - Count of calls checked for number-based PII data
- callPiiDataFoundCount (int) - Count of calls where number-based PII data was found
Sort Types
Same fields as Filter Types and Group Types, plus:
- {Custom Metrics Field} (decimal) - Any field specified in Custom Metrics.
Custom Metrics
The following custom metrics can be specified See Custom Metrics for details.
Metric Fields Available:
- callCount
- queueDurationMax
Condition Fields Available:
- dgrp
- ch
- ivrRef
- dialplanRef
- callRating
- callDirection
- callStage
- operatorRef
- pub
- queueName
- teamName
- queueBand
Response:
Returns a an aggregated metrics list based on your group settings.
Operator Call Metrics
This report provides operator call metrics.
Request:
GET Params
- igrp (int) - IGRP to get metrics for.
- startDate (string) - Start Date to filter by, see Dates and Timezones.
- endDate (string) - End Date to filter by, see Dates and Timezones.
- chType (string) OPTIONAL - Channel Type to filter by.
- group (array) - One or more groups, see Group Types.
- limit (int) OPTIONAL - The maximum number of rows to return.
- sort (array) OPTIONAL - One or more sorts, see Sort Types.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- offset (array) OPTIONAL - The offset to apply.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
Group Types
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricWeekStartDate (int) - Metric week start date (formatted as yyyy-mm-dd, week begins on Sunday)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- metricHourQuarter (int) - The quarter of the hour (between 1-4)
- callDirection (string) - The call direction, can be one of (in or out)
- ch (int) - The channel ID.
- ivrRef (string) - The IVR reference
- dialplanRef (string) - The dialplan reference
- callStage (string) - The stage the call was at when it ended, can be one of (ring, ivr, queue, bridge)
- operatorRef (string) - The operator reference
- pub (string) - The marketing publisher for the call, or in PBX IGRPs this holds the call tracking IGRP name
- queueName (string) - The name of the queue that the call was placed in
- teamName (string) - The name of the PBX team that the call was sent to
Filter Types
Same fields as Group Types*, plus:
- callCount (int) - The total number of calls
- ringCount (int) - The total number of calls that reached the ring stage
- ivrCount (int) - The total number of calls that reached the ivr stage
- queueCount (int) - The total number of calls that reached the queue stage
- bridgeCount (int) - The total number of calls that reached the bridge stage
- callDurationTotal (int) - The total call duration
- ringDurationTotal (int) - The total ring duration
- ivrDurationTotal (int) - The total ivr duration
- queueDurationTotal (int) - The total queue duration
- bridgeDurationTotal (int) - The total bridge duration
- callDurationAverage (int) - The average call duration
- ringDurationAverage (int) - The average ring duration
- ivrDurationAverage (int) - The average ivr duration
- queueDurationAverage (int) - The average queue duration
- bridgeDurationAverage (int) - The average bridge duration
Sort Types
Same fields as Filter Types and Group Types, plus:
- {Custom Metrics Field} (decimal) - Any field specified in Custom Metrics.
Custom Metrics
The following custom metrics can be specified See Custom Metrics for details.
Metric Fields Available:
- callCount
- ringCount
- ivrCount
- queueCount
- bridgeCount
- callDurationTotal
- ringDurationTotal
- ivrDurationTotal
- queueDurationTotal
- bridgeDurationTotal
- callDurationAverage
- ringDurationAverage
- ivrDurationAverage
- queueDurationAverage
- bridgeDurationAverage
Condition Fields Available:
- callDirection
- ch
- ivrRef
- dialplanRef
- callStage
- operatorRef
- pub
- queueName
- teamName
Response:
Returns a an aggregated metrics list based on your group settings.
Operator Availability Metrics
This report provides operator availability metrics.
Request:
GET Params
- igrp (int) - IGRP to get metrics for.
- startDate (string) - Start Date to filter by, see Dates and Timezones.
- endDate (string) - End Date to filter by, see Dates and Timezones.
- group (array) - One or more groups, see Group Types.
- limit (int) OPTIONAL - The maximum number of rows to return.
- sort (array) OPTIONAL - One or more sorts, see Sort Types.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- offset (array) OPTIONAL - The offset to apply.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
Group Types
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricWeekStartDate (int) - Metric week start date (formatted as yyyy-mm-dd, week begins on Sunday)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- metricHourQuarter (int) - The quarter of the hour (between 1-4)
- operatorRef (string) - The operator reference
- operatorState (string) - The operator state (online/offline/dnd)
Filter Types
Same fields as Group Types*, plus:
- operatorStateDuration (string) - The duration that the operator was in this state
Sort Types
Same fields as Filter Types and Group Types.
Response:
Returns a an aggregated metrics list based on your group settings.
Inbound Call Charge Metrics
This report provides a list of inbound call metrics entries.
Request:
GET Params
- igrp (int) - IGRP to get metrics for.
- rootOrgId (int) OPTIONAL - Filter Segments accessible by an organisation.
- sort (array) - One or more sorts, see Sort Types.
- group (array) OPTIONAL - One or more groups, see Group Types.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- startDate (string) - Start Date to filter by, see Dates and Timezones.
- endDate (string) - End Date to filter by, see Dates and Timezones.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
- limit (int between 1 and 10000) OPTIONAL - Limit the number of rows to return.
Filter Types
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricWeekStartDate (int) - Metric week start date (formatted as yyyy-mm-dd, week begins on Sunday)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- currencyCode (int) - Currency Code (three-letter ISO-4217 currency code)
- inboundNumberType (string) - Inbound Number Type
- inboundNumberTitle (string) - Inbound Number Title
- inboundNumberTypePrefix (int) - Inbound Number Type Prefix
Group Types
Same fields as Filter Types, see above.
Sort Types
Same fields as Filter Types, plus:
- totalCallCount (int) - Total Call Count
- totalCallFailCount (int) - Total Call Fail Count
- totalCallDuration (int) - Total Call Duration
- totalRoundedCharge (int) - Total Rounded Charge
Response:
Returns a an aggregated metrics list based on your group settings.
Outbound Call Charge Metrics
This report provides a list of outbound call metrics entries.
Request:
GET Params
- igrp (int) - IGRP to get metrics for.
- rootOrgId (int) OPTIONAL - Filter Segments accessible by an organisation.
- sort (array) - One or more sorts, see Sort Types.
- group (array) OPTIONAL - One or more groups, see Group Types.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- startDate (string) - Start Date to filter by, see Dates and Timezones.
- endDate (string) - End Date to filter by, see Dates and Timezones.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
- limit (int between 1 and 10000) OPTIONAL - Limit the number of rows to return.
Filter Types
- metricDate (string) - Metric date (formatted as yyyy-mm-dd)
- metricYear (int) - Metric year
- metricMonth (int) - Metric month (between 1-12)
- metricWeekStartDate (int) - Metric week start date (formatted as yyyy-mm-dd, week begins on Sunday)
- metricDayOfWeek (int) - Metric day of week (between 1-7, 1 being Sunday)
- metricHourOfDay (int) - Metric hour of day (between 0-23)
- currencyCode (int) - Currency Code (three-letter ISO-4217 currency code)
- outboundNumberType (string) - Outbound Number Type
- outboundNumberTitle (string) - Outbound Number Title
- outboundNumberTypePrefix (int) - Outbound Number Type Prefix
Group Types
Same fields as Filter Types, see above.
Sort Types
Same fields as Filter Types, plus:
- totalCallCount (int) - Total Call Count
- totalCallFailCount (int) - Total Call Fail Count
- totalCallDuration (int) - Total Call Duration
- totalRoundedCharge (int) - Total Rounded Charge
Response:
Returns a an aggregated metrics list based on your group settings.