• 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 Installation Groups

Introduction

An Installation Group (IGRP) represents one or more web sites that are tracked (and reported) together under a single installation ID.

• Each IGRP is assigned a numeric ID that can be used to reference it in the APIs.
• Each IGRP can also be assigned a Reference string, which can be used to refer to an IGRP using a customer’s internal identifier.

IGRP Properties

These are the properties that can be accessed using the API.

• igrp (int) - Installation ID.
• igrpName (string) - Friendly name of the Installation (e.g. “My Website”)
• packageType (string) - Package of the Installation.
• orgId (int) - Organisation this IGRP belongs to.
• igrpType (string) - The type of IGRP. Can be blank (empty) or pbx for phone system installs
• sfOrgRef (string) - The Salesforce organisation ID this installation is associated with.
• platform (string) - The platforms that the IGRP is visible on (‘hub’, ‘portal’, ‘both’).
• conversationAnalytics (int) - Read-only. A flag (1 or 0) indicating whether this IGRP has Conversation Analytics enabled.
• features (array) - Read-only. A list of features available to the IGRP.
• editionName (string) - Read-only. Natural name of edition which is used by IGRP.
• editionCode (string) - Read-only. System code of edition which is used by IGRP.

List IGRPs

Returns a list of IGRPs that the current user can access.

Request:

GET /reports/v2/igrps

GET Params

• rootOrgId (integer) OPTIONAL - limit the result set within this organisation branch.
• filter (array) OPTIONAL - One or more filters, see Filter Types.
• sort (array) OPTIONAL - One or more sorting params, see Sort Types.
• limit (integer) OPTIONAL - limit on the result set.
• offset (integer) OPTIONAL - offset of the result set.

Filter Types

• igrp (int) - Installation ID.
• igrpName (string) - Installation Name.
• packageType (string) - Type of the package.
• orgId (int) - Organisation this IGRP belongs to.
• igrpType (string) - The type of IGRP. Can be blank (empty) or pbx for phone system installs
• sfOrgRef (string) - The Salesforce organisation ID this installation is associated with.
• platform (string) - The platforms that the IGRP is visible on (‘hub’, ‘portal’, ‘both’).
• conversationAnalytics (int) - Read-only. A flag (1 or 0) indicating whether this IGRP has Conversation Analytics enabled.
• editionName (string) - Read-only. Natural name of edition which is used by IGRP.
• editionCode (string) - Read-only. System code of edition which is used by IGRP.

Sort Types

Same fields as Filter Types, see above.

Response:

Returns list of IGRPs that the current user can access.

Read IGRP Config

Returns the properties for a particular IGRP.

Request:

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

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

Response:

Returns the requested IGRP details.