• 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 Goals

Introduction

Goals are groups of triggers that have matched some business criteria based on rules.

• Each Goal is given a numeric ID which can be used to reference it in the APIs.
• A Trigger can be marked with a single Goal ID.
• Each Goal can be configured with 1 or more Goal Ranges which specify which triggers should be marked as this Goal.
• Goals contain rules that are activated for a given date range.
• A Goal ID of 0 is used to indicate a trigger has no Goal.
• Goals can be assigned an order number and are actioned in ascending order.

Goal Properties

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

• goalId (int) - Goal ID
• igrp (int) - IGRP ID
• goalTitle (string) - The goal name
• goalDescription (string) - A description of the goal
• goalStatus (int) - Infinity Status code indicating status of goal (E.g. 200)
• deDupeFields (array) - An array of comma delimited values.
• deDupeLookback (integer) - An integer with the number of days deduplication is applied.
• actionConfig (array) - The actions for this goal
• criteriaConfig (array) - The criteria for this goal

List Goals

Lists the goals for an IGRP.

Request:

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

URL Path Params

• IGRP SPECIFIER (int) - Installation ID.

GET Params

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

Filter and Sort Fields

• goalId (int) - Goal ID
• goalTitle (string) - The goal name
• goalStatus (int) - Infinity Status code indicating status of goal (E.g. 200)

Response:

HTTP 200 - OK