Content API Introduction

The Content API allows your third-party software tool to access information relating to all existing content in Publish, whether content has been published, drafted, scheduled, or copied.

Note:

This article offers an introduction to the Falcon Content 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 Features are Available?

There are 6 metrics available in the Content API:

  • Get Channel Content
  • Get Copied Content
  • Get Instagram Content
  • Get Publication Labels
  • Add Publication Labels
  • Remove Publication Labels

Note:

To remain compliant with Twitter’s Terms of Service, it’s not possible to include Twitter content in any Content API results.

Get Channel Content

Using the Get channel content endpoint, you can receive information about all content within your Falcon organization, whether drafted, scheduled, or published. The returned data will include URLs to the media (images, videos, or link thumbnails) and caption text.

You can choose to narrow down your results by specifying a Post ID, Channel ID, network, status (e.g., drafted, scheduled, or published), promotion status, labels, or visibility. Please see the guides below for help locating the Post ID or Channel ID.

Get Copied Content

Using any existing Post ID in Falcon, you can use the get copied content endpoint to return a list of drafted, scheduled, and published posts which were copied from that original content. Your results will include the network, media (images, videos, or links), text, labels, any applicable approvers, and more.

Find out how to locate your Post ID from the guide below.

Get Publication Labels, Add Publication Labels, and Remove Publication Labels

Using the 3 available endpoints for publication labels, you can discover which labels are attached to your content, or choose to add or remove labels. To get started, you will need:

  1. The ID for your content. Find out how to get the content ID below.
  2. The ID for your label (only applicabel when adding or removing labels). To find an existing Label ID, use the Search labels endpoint from the Labels API as described here.

How Can I Find My Post ID?

There are two possible ways to find your Post ID:

Via the Content API

If you need the ID for your content in order to discover information relating to labels or copied posts, you can first use the Get Channel Content endpoint listed above. The results will contain the IDs for all applicable content.

Via the Falcon Platform

In Falcon, any user can easily locate the ID for your content, whether it’s a draft, scheduled post, or published post, by clicking to open the post. The ID will automatically appear in the URL, immediately following the applicable network as shown below.

mceclip0.png

How Can I Find My Channel ID?

There are two possible ways to find the ID for your Channel:

Via the Channel API

Using the Get Channels endpoint from the Falcon Channel API, results will contain information relating to all existing Channels in your Falcon organization including the Channel ID for each.

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 Content API?

There are four common uses for the Content API:

  1. You may decide to produce an external dashboard which displays a feed of your most recently published posts, potentially intended to be displayed on a big screen.
  2. Similarly, you could create an external dashboard which displays a feed of your Falcon organization’s up-coming scheduled or drafted posts.
  3. You may decide to create a custom insights report to discover, for example, the number of posts broken down by Channel, group of Channels (locales), media type, or label.
  4. Using the add publication labels endpoint, you may decide to build a custom logic to label specific content after it has been successfully published.

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