Reports API Version 2 Channels
Introduction
A Channel is a container for triggers from a particular marketing source. Triggers can be made up of Online and Offline events, such as web site page views or calls. Each Channel is assigned a numeric ID that can be used to reference it in the APIs.
- Each Channel is assigned a numeric ID that can be used to reference it in the APIs.
- A Channel ID of 0 means “Unknown” and is used when a Visitor’s marketing source cannot be detected, or for assigning phone numbers to a shared channel pool (See Dial-In Groups)
List Channels
Lists the Channels for an IGRP.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
GET Params
- 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
- channelId (string) - Channel ID
- channelName (string) - Channel Name
- channelType (string) - Channel Type
- channelOrder (string) - Channel Order
Sort Types
- channelId (string) - Channel ID
- channelName (string) - Channel Name
- channelType (string) - Channel Type
- channelOrder (string) - Channel Order
Response:
Returns a list of Channels under the given IGRP spec.
- igrp (int) - Installation ID.
- channelId (int) - Channel ID.
- channelName (string) - Friendly name of the channel (e.g. “My Channel”)
- channelType (string) - Type of Channel (e.g. Direct(direct), Custom (cust) etc.)
- channelOrder (string) - Channel ordering.
Get Channel Config
Get the properties for a particular channel.
Request:
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
- channelId (int) - Channel ID of the channel for which the details are required.
Response:
Returns the details of the channel specified by the {IGRP SPECIFIER} and {channelId}
- igrp (int) - Installation ID.
- channelId (int) - Channel ID.
- channelName (string) - Friendly name of the channel (e.g. “My Channel”)
- channelType (string) - Type of Channel (e.g. Direct(direct), Custom (cust) etc.)
- channelOrder (string) - Channel ordering.