• Home
• Config V2 Basics
• Config V2 Organisations
• Config V2 Organisation Types
• Config V2 Channels
• Config V2 Installation Groups
• Config V2 Report Schedule Subscribers
• Config V2 Segments
• Config V2 Dial-In Groups
• Config V2 Goals
• Config V2 Goal Groups
• Config V2 Numbers
• Config V2 Custom
• Config V2 Profile
• Config V2 Users
• Config V2 Roles
• Config V2 Visitor Types
• Config V2 Attribution
• Config V2 SIP Phone System
• Config V2 Notifications
• Config V2 Dialplans
• Config V2 Integrations
• Config V2 PPC
• Config V2 DGRP maps
• Config V2 DGRP map items
• Config V2 IGRP Caller Blocks
• Config V2 Caller Insight
• Config V2 Caller Insight for Salesforce
• Config V2 Call Rating
• Config V2 Custom Vocabulary
• Reports V2 Basics
• Reports V2 Installation Groups
• Reports V2 Dial-In Groups
• Reports V2 Triggers
• Reports V2 Triggers (Deprecated)
• Reports V2 Custom
• Reports V2 Metrics
• Reports V2 Call Rating
• Reports V2 Channels
• Reports V2 Organisations
• Reports V2 Organisation Types
• Reports V2 Segments
• Reports V2 Visitors
• Reports V2 Attribution
• Reports V2 Audit
• Reports V2 Currencies
• Reports V2 Goals

• Reports V2 Real Time

• Reports V2 PBX triggers
• Export V2 Invoices
• Event API Basics
• Event API Example
• Event FTP Upload
• Call Events
• Salesforce Events
• Config V2 Oauth2
• Config V2 Scheduled Reports
• Reports V2 PPC
• Config V2 Keyword Spotting
• Reports V2 Call Keywords

Reports API Version 2 Real Time

Introduction

These reports display real-time data about your Installation.

PBX Active Calls

Lists active PBX calls (if you have a PBX Installation).

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/pbxActiveCalls

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

GET Params

• tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
• excludePiiData (flag) OPTIONAL - If PII Data should be redacted. This only applies to users who have the piiData permission, otherwise data is always redacted. This flag has no effect for users without the piiData permission.

Response:

A list of active calls in various states (ringing, queueing, bridged).

PBX User Status

Lists PBX user statuses (if you have a PBX Installation) and dashboard flag, which indicates if PBX user is available for real-time dashboard.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/pbxUserStatus

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

GET Params

• tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
• sort (array) OPTIONAL - One or more sorts, see Sort Types.

Sort Types

• stateStartDatetime (string) - The time the state was last changed

Response:

A list of PBX users, their state (available/unavailable) and dashboard flag, which indicates if PBX user is available for real-time dashboard.

Active Call

Returns a row with marketing details for a single call, given an IGRP and either a call reference or a caller ID

Requests from users without permission to see PII Data will be denied.

Request:

GET /reports/v2/igrps/{IGRP SPECIFIER}/activeCall

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

GET Params

• callRef (string) OPTIONAL - Call reference.
• srcPhoneNumber (string) OPTIONAL - Caller ID in E.164 format, which may be local, international or anonymous. The preceding “+” symbol should be URL encoded to “%2B”.

Either callRef or srcPhoneNumber should be supplied for results.

Response:

Tracking pools with Caller Insight Partner Framework - Basic mode:

A row of visitor information related to the call within the last 24 hours of request time for the supplied call reference or caller ID.

• igrp (int) - The Infinity Installation ID of the active call
• dgrp (int) - DGRP ID related to the call
• txr (string) - Unique Reference of the active call

Tracking pools with Caller Insight Partner Framework - Advanced mode:

A row of visitor and marketing information related to the call within the last 24 hours of request time for the supplied call reference or caller ID.

• igrp (int) - The Infinity Installation ID of the active call
• igrpName (string) - The Infinity Installation Name of the active call
• vid (string) - The ID of the visitor, that the active call is matched to
• dgrp (int) - DGRP ID related to the call
• dgrpName (string) - The name of the DGRP the call was linked to
• ch (int) - Marketing Source Channel ID
• chName (string) - Marketing Source Channel Name
• chType (string) - Marketing Source Channel Type
• pub (string) - Marketing Source Publisher
• campaign (string) - Marketing Source Campaign
• adGroup (string) - Marketing Source AdGroup
• matchRef (string) - Marketing Source Keyword
• txr (string) - Unique Reference of the active call
• srcPhoneNumber (string) - Source phone number
• dialledPhoneNumber (string) - Dialled phone number
• destPhoneNumber (string) - Destination phone number
• triggerDatetime (datetime) - The datetime of the call (in UTC timezone)
• landingPageTitle (string) - Title of the landing page
• pageTitle (string) - Title of the page the user was on
• landingHref (string) - The visitor landing page URI. The page the user entered the website
• conversionHref (string) - The visitor conversion page URI. The page the user was on when the call started
• vref (string) - The visitor referrer URI. The page the visitor came from
• callState (string) - The hangup state of the call
• callDuration (int) - Call duration of A-leg (seconds the A-leg was in answered state)
• bridgeDuration (int) - Call bridge duration (seconds the A-leg and B-leg were bridged together)

For customers using custom variables or with pass-through tags enabled these will be included in the response where available.

• pt_{tagName} (string) - The value of the pass-through tag
• c_{varName} (string) - The value of the custom variable