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).

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.

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 /reports/v2/metrics/channels

GET Params

Group Types

Filter Types

Same fields as Group Types, plus:

Sort Types

Same fields as Filter Types

Custom Metrics

The following custom metrics can be specified See Custom Metrics for details.

Metric Fields Available:

Condition Fields Available:

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 /reports/v2/metrics/outcomes

GET Params

Group Types

Filter Types

Same fields as Group Types, plus:

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 /reports/v2/metrics/sources

GET Params

Group Types

Filter Types

Same fields as Group Types, plus:

Sort Types

Same fields as Filter Types

Custom Metrics

The following custom metrics can be specified See Custom Metrics for details.

Metric Fields Available:

Condition Fields Available:

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 /reports/v2/metrics/callOperations

GET Params

Group Types

Filter Types

Same fields as Group Types*, plus:

Sort Types

Same fields as Filter Types and Group Types, plus:

Custom Metrics

The following custom metrics can be specified See Custom Metrics for details.

Metric Fields Available:

Condition Fields Available:

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 /reports/v2/metrics/callQueue

GET Params

Group Types

Filter Types

Same fields as Group Types*, plus:

Sort Types

Same fields as Filter Types and Group Types, plus:

Custom Metrics

The following custom metrics can be specified See Custom Metrics for details.

Metric Fields Available:

Condition Fields Available:

Response:

Returns a an aggregated metrics list based on your group settings.

Operator Call Metrics

This report provides operator call metrics.

Request:

GET /reports/v2/metrics/callUser

GET Params

Group Types

Filter Types

Same fields as Group Types*, plus:

Sort Types

Same fields as Filter Types and Group Types, plus:

Custom Metrics

The following custom metrics can be specified See Custom Metrics for details.

Metric Fields Available:

Condition Fields Available:

Response:

Returns a an aggregated metrics list based on your group settings.

Operator Availability Metrics

This report provides operator availability metrics.

Request:

GET /reports/v2/metrics/pbxUser

GET Params

Group Types

Filter Types

Same fields as Group Types*, plus:

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 /reports/v2/metrics/callUsage/in

GET Params

Filter Types

Group Types

Same fields as Filter Types, see above.

Sort Types

Same fields as Filter Types, plus:

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 /reports/v2/metrics/callUsage/out

GET Params

Filter Types

Group Types

Same fields as Filter Types, see above.

Sort Types

Same fields as Filter Types, plus:

Response:

Returns a an aggregated metrics list based on your group settings.