• 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

Version 2 Goal Groups

Introduction

Requests to list, create, update and delete goal groups for an IGRP.

• Each goal group has a numeric ID to reference it in the APIs.
• A goal group can contain one or multiple goals.
• A goal group is stored for a single IGRP.

Goal Group Properties

• goalGroupId (int) - An integer with the goal group ID.
• goalGroupName (string) - The goal group name.
• goalGroupDesc (string) - The description for the goal group.
• goalGroupStatus (int) - The goal group status.
• goalGroupTypeId (int) - The goal group type ID.
• createDatetime (datetime) - Create date and time of the goal group.
• updateDatetime (datetime) - Update date and time of the goal group.
• deleteDatetime (datetime) - Delete date and time of the goal group.

List Goal Groups for an IGRP

Lists the goal groups for an IGRP.

Request:

GET /config/v2/igrps/{IGRP ID}/goalGroups

Segment Params

• IGRP ID (int) - Installation ID.

GET Params

• filter (array) OPTIONAL - One or more filters.
• sort (array) OPTIONAL - One or more sorting params.
• limit (int) OPTIONAL - Limit on the result set.
• offset (int) OPTIONAL - Offset of the result set.

Filter Types

The goal group list may be filtered by any of the returned fields.

Sort Types

The goal groups list may be sorted by any of the returned fields. By default goal groups are ordered by goal group name in ascending order.

Response:

Returns a list of goal groups for an IGRP.

• goalGroupId (int) - An integer with the goal group ID.
• goalGroupName (string) - The goal group name.
• goalGroupDesc (string) - The description for the goal group.
• goalGroupStatus (int) - The goal group status.
• goalGroupTypeId (int) - The goal group type ID.
• createDatetime (datetime) - Create date and time of the goal group.
• updateDatetime (datetime) - Update date and time of the goal group.
• deleteDatetime (datetime) - Delete date and time of the goal group.
• goalGroupTypeName (datetime) - The goal group type name.
• goalCount (datetime) - the number of goals contained in the goal group.

{"goalGroupId":"1","goalGroupName":"Goal Group name 1","goalGroupDesc":"Goal Group Description 1","goalGroupStatus":"200","goalGroupTypeId":"1","createDatetime":"2019-09-30 10:00:00","updateDatetime":"2019-09-30 10:15:00","deleteDatetime":"0000-00-00 00:00:00","goalGroupTypeName":"Goal Group Type Name 1","goalCount":"3"}
{"goalGroupId":"2","goalGroupName":"Goal Group name 2","goalGroupDesc":"Goal Group Description 2","goalGroupStatus":"200","goalGroupTypeId":"1","createDatetime":"2019-09-30 15:00:00","updateDatetime":"2019-09-30 15:15:00","deleteDatetime":"0000-00-00 00:00:00","goalGroupTypeName":"Goal Group Type Name 1","goalCount":"0"}

Read Goal Group properties

Read goal group properties for the specified goal group ID and IGRP.

Request:

GET /config/v2/igrps/{IGRP ID}/goalGroups/{GOAL GROUP ID}

Segment Params

• IGRP ID (int) - Installation ID.
• GOAL GROUP ID (int) - Goal Group ID.

Response:

Returns details of a goal group for an IGRP.

• goalGroupId (int) - An integer with the goal group ID.
• goalGroupName (string) - The goal group name.
• goalGroupDesc (string) - The description for the goal group.
• goalGroupStatus (int) - The goal group status.
• goalGroupTypeId (int) - The goal group type ID.
• createDatetime (datetime) - Create date and time of the goal group.
• updateDatetime (datetime) - Update date and time of the goal group.
• deleteDatetime (datetime) - Delete date and time of the goal group.
• goalGroupTypeName (datetime) - The goal group type name.
• goalCount (datetime) - the number of goals contained in the goal group.

{"goalGroupId":"1","goalGroupName":"Goal Group name 1","goalGroupDesc":"Goal Group Description 1","goalGroupStatus":"200","goalGroupTypeId":"1","createDatetime":"2019-09-30 10:00:00","updateDatetime":"2019-09-30 10:15:00","deleteDatetime":"0000-00-00 00:00:00","goalGroupTypeName":"Goal Group Type Name 1","goalCount":"3"}

Create Goal Group config

Creates a new goal group and its properties for an IGRP.

Request:

POST /config/v2/igrps/{IGRP ID}/goalGroups

Segment Params

• IGRP ID (int) - Installation ID.

POST Params

• goalGroupName (string) - Goal Group name.
• goalGroupDesc (string) - Goal Group description.
• goalGroupTypeId (int) - The goal group type ID.
• goals (array) OPTIONAL - An array of Goal IDs mapped to this Goal Group.

Response:

Returns the HTTP 201 (Created) status code if successful.

{"goalGroupId":"3"}

Update Goal Groups Config

Updates the configuration of an existing goal group.

Request:

POST /config/v2/igrps/{IGRP ID}/goalGroups/{GOAL GROUP ID}

Segment Params

• IGRP ID (int) - Installation ID.
• GOAL GROUP ID (int) - Goal Group ID.

POST Params

• goalGroupName (string) - Goal Group name.
• goalGroupDesc (string) - Goal Group description.
• goalGroupTypeId (int) - The goal group type ID.
• goals (array|string) OPTIONAL - An array of Goal IDs (int) mapped to this Goal Group. If set to an empty string it will remove all Goals mapped to the Goal Group.

Response:

Returns the HTTP 204 (No Content) status code if update successful.

HTTP 204 - NO CONTENT

Delete Goal Group Config

Sets goal group status to inactive for an existing goal group.

Request:

DELETE config/v2/igrps/{IGRP ID}/goalGroups/{GOAL GROUP ID}

Segment Params

• IGRP ID (int) - Installation ID.
• GOAL GROUP ID (int) - Goal Group ID.

Response:

Returns the HTTP 204 (No Content) status code if delete successful.

HTTP 204 - NO CONTENT

List Goal Group Types

Lists the goal group types.

Request:

GET /config/v2/goalGroupTypes

GET Params

• filter (array) OPTIONAL - One or more filters.
• sort (array) OPTIONAL - One or more sorting params.
• limit (int) OPTIONAL - Limit on the result set.
• offset (int) OPTIONAL - Offset of the result set.

Filter Types

The goal group types list may be filtered by any of the returned fields.

Sort Types

The goal group types list may be sorted by any of the returned fields. By default goal group types are ordered by goal group type ID in ascending order.

Response:

Returns a list of goal group types for an IGRP.

• goalGroupTypeId (int) - The goal group type ID.
• goalGroupTypeName (string) - The goal group type name.
• goalGroupTypeDesc (string) - The description for the goal group type.

{"goalGroupTypeId":"1","goalGroupTypeName":"Goal Group Type Name 1","goalGroupTypeDesc":"Goal Group Type Description 1"}
{"goalGroupTypeId":"2","goalGroupTypeName":"Goal Group Type Name 2","goalGroupTypeDesc":"Goal Group Type Description 2"}