Channel API Introduction

The Channel API allows your third-party software to directly access information relating to each of your Channels in Falcon. With the Channel API, you can view your existing Channels and Channel Groups

In this article, find out more about the information available in the Channel API and how you could potentially use the data.

Note:

This article offers an introduction to the Falcon Channel API. For more information, please visit Falcon’s API Technical Documentation here. Don’t yet have access to Falcon APIs? Find out how to get access here.

What Information is Available?

There are five endpoints available via the Channel API:

  • Get Channels
  • Get Instagram Channels
  • Get Channel
  • Get Channel Groups
Get Channels

Using the get channels endpoint, you can receive all available information for all Channels associated with your Falcon organization, whether connected or disconnected. Results will include each Channel’s ID, UUID, associated network, name, connected status, and more.

You can limit your results to a total number of Channels and also sort your results by name (ascending or descending).

Get Instagram Channels

Using the get Instagram Channels endpoint, you can receive information relating to any Instagram Channels which are currently connected to your Falcon org. Your results will include the Channel’s name, ID, UUID, profile image, username, fans, and more.

Get Channel

The Get Channel endpoint will return all information listed above for the Get Channels endpoint, though only for only one specified Channel. You can specify the Channel using the Channel ID.

For help obtaining your Channel’s ID, please follow the guide below.

Get Channel Groups

If you have created any Channel Groups in Falcon, you can use the Get Channel Groups endpoint to receive the information about all Channel Groups in your Falcon organization.

Your results will include the Channel Group ID, creation date, title, included Channels, and more.

How Can I Find My Channel ID?

For the above endpoint, Get Channel, you will first need to obtain your Channel ID. There are two possible ways to find the ID for your Channel:

Via the Channel API

Using the above endpoint, Get Channels, your results will contain the information related to all Channels associated with your Falcon organization, including each Channel’s Channel ID.

Via the Falcon platform

In Falcon, any user with a user role of Team Leader or Admin can find the ID for your Channel by clicking Settings > Channels > (Select the Channel).

The Channel ID will appear beside the Channel name at the top of the page as shown below.

mceclip1.png

How Can I Use the Channel API?

Using the Channel API, you could include the list of your organization's Channels along with their connected status or current Channel Group setup in a custom report, external Dashboard, or big screen. Doing so could help to alert users of Channels in need of reconnection and provide awareness of filtering options in Publish.

In addition, the Channel API enables you to locate your Channel IDs which you will need for creating Engage exports via the Engage API or configuring your Channel's content via the Content API.

Where Can I find the Technical Documentation?

For general information and descriptions of the available APIs, check out the Help Center guides here. To view the Falcon API Technical Documentation, please visit: falconio.docs.apiary.io

Was this article helpful?
0 out of 0 found this helpful