Organization API Introduction

The Organization API allows your third-party software to easily access information related to your organization's Falcon package and usage. Using the Organization API, you can find out the name of your Falcon package as well as contractual limitations relating to Listen, such as mentions, number of Projects available, historical data, retention days, and more.

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

Note:

This article offers an introduction to the Falcon Organization 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?

Using the Get Organization Metrics endpoint, you will receive the following information:

Package Name

Each organization in Falcon will be signed up to a particular package name, for example, Starter, Premium, or Enterprise. Find out the name of the package.

Spent Mentions

The total number of Listen mentions your organization has gathered since the beginning of the month.

Max Projects

The maximum number of (Classic) Listen Projects your organization may create as per your contract with Falcon.

Max Topics

The maximum number of (Classic) Listen Topics your organization may create as per your contract with Falcon.

Current Projects

The total number of active (Classic) Listen Projects which have been created by your organization. Deleted Projects are not included in the total.

Current Queries

The total number of active (Classic) Listen Topics which have been created by your organization. Deleted Topics are not included in the total.

Max Mentions

The total number of monthly mentions available to your organization as per your contract with Falcon. Find out more about monthly mentions usage here.

Retention Days

The total number of days your acquired (Classic) Listen Mentions and Listen data will remain available to your organization.

Historical Days

The total number of days in the past you will see (Classic) Listen when you create a new Topic.

How Can I Use the Organization API?

The Organization API allows you to keep up to date with your Falcon organization’s activities and platform usage. As such, metrics surrounding the team’s performance and statistics can be displayed in an external report or dashboard, potentially intended for a big screen.

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