Close

Channel API

The Channel API delivers content to the requester that corresponds to any fitting message published (made live) in a specified channel. Messages can be linked to ongoing campaigns or be independent from campaigns. To work with the Channel API valid Channels and Content are needed, for information on how to create campaigns or AB tests check the Campaigns and AB Test guides.

Channels: get

Request Definition

The API URL is assigned per organization. We use “{orgname}” as an example, when testing use your organization’s assigned subdomain name defined in the Omniata panel.

GET https://{orgname}.engager.omniata.com/channel

Parameters

Calls to the Channel API accept the following parameters:

Name Example Description
api_key
mandatory
11111111 Identifies multiple aspects of the events such as the organization and environment.
uid
mandatory
10000001A Uniquely identifies a user within the organization’s UID domain.
channel_id
mandatory
7 The unique identifier of the channel that is being requested.
require_user
optional
1 If this parameter is set to 1 the response is set to HTTP 404 if the user does not exist in Omniata. If the parameter is not set, and the user does not exist, the response is the default configured for the channel.
ts
optional
1490365385 Unix timestamp for testing scheduled campaigns. Emulates a request being made in the specified timestamp.

Response

All requests will return a standard JSON response. The JSON is build according to the published messages in the channel, and to segmentation rules applied.

Example request:

$ curl "http://{orgname}.engager.omniata.com/channel?api_key=11111111&uid=10000001A&channel_id=7&require_user=1"

Example response:

{ "content": [{
 "main": {
  "level_config": 1
 }
}, 
{
 "store": {
  "promo": 3,
  "weekly": "Beginner Package"
 }
},
{
 "global_promo": "AB5TK"
}] }

The first level container node is standard, whereas the user-defined content is included in the [ ] elements and represented by their respective content, each content is separated by a comma. Any type of valid JSON can be included, for more examples and details can be found in the Content section.

This article was last updated on March 30, 2017 13:00. If you didn't find your answer here, search for another article or contact our support to get in touch.