Data API
(Currently in Alpha Release)
Last updated
(Currently in Alpha Release)
Last updated
Circle's Data API provides a comprehensive set of events to track various actions and changes within your community. See endpoints
Available on our Plus Platform plan and above, the Data API is invaluable for analysts, product/course managers, and business leaders looking to analyze their community and business.
By importing all their community data into their own data warehouse, the Data API provides the ability to develop custom reports and combine your community data with other sources to get a more holistic view of your business.
Up-to-date analytics: Track user actions and community updates as they happen in your own data stack.
Enhanced reporting: Build custom reporting and dashboards using your own BI tool.
Custom Integrations: Integrate your Circle data with other tools and services to gain a deeper understanding of your business.
Without the Data API, you can access data and insights from your Circle community in two ways:
In-product dashboards: these provide an excellent standard set of insights to help you understand community performance and stay on top of major trends. However, many of our highly advanced community owners need more depth and flexibility to track metrics that are specific to their business and objectives. For these customers, until now, the only other option has been to take CSV exports of their community data
CSV Exports: this option gives you more control and allows you to study your data at an extremely granular level. However, CSV exports can’t be automated and require manual work to ingest this data for analysis over and over again, and they don’t cover all the use cases that the Data API is designed for.
Some of our advanced users with programming skills or access to developers on their team also use our Admin API to extract some data. However, the main purpose of these API is to administer your community and automate actions, not to perform analysis on your Circle data. To repurpose the Admin API to produce data is cumbersome, and requires clever scripting at the customer’s end to get around its limitations.
To address this need and supercharge your analytics, we've designed the Data API to give you a high-throughput, purpose-driven interface to all your Circle data, which you can use to plug into your own data warehouse with an ETL tool, such as Airbyte.
We recommend using the Data API to store data in a Data Warehouse where you can transform it into any desired data models and metrics for tracking and analysis. We have made the API compatible with ETL tools such as Airbyte (recommended) or Fivetran. A typical set up this API could work as follows:
Expertise required
On your end, you'll need a Data Analyst or an individual who can connect the Data API via an ETL tool and store it in a data warehouse. Once connected, they will need to write SQL queries on top of the gathered data to generate custom metrics and insights.
The Data API is currently in Alpha release and only available on Circle’s new Plus Platform Plan, a special pricing plan designed for customers looking to gain access to features like the Data API, higher API limits, and more.
If you're interested, please use this link to request a time to speak with our sales team:
👉 Schedule a Meeting to Learn about the Data API
