Access Zype Analytics 3 Data via API

We’re excited to introduce the new Zype Analytics 3 API — a powerful update in the Analytics 3.1 release that provides seamless, programmatic access to your video engagement, revenue, and platform analytics data.

With support for real-time and historical data retrieval, the Analytics 3 API empowers customers to integrate Zype’s analytics directly into external dashboards and third-party tools. 

What’s New?

Analytics 3 data is now programmatically available through our Analytics 3 API. The new API endpoints allow you to:

• Access Real-Time + Historical Data: Query both up-to-the-minute and long-term performance data
• Filterable Queries: Standard response formats with filters and group-by query parameters
• Build Your Own Dashboards: All Analytics 3 dashboards (Engagement, Revenue, Platform Dynamics) are API-driven, and you now have the ability to build your own API-driven dashboards using the same data
  
   

New available endpoints will support queries for Platform Dynamics, Revenue, and Engagement analytics data:

• Platform Dynamics:
  • List Consumers
  • List Key Metrics Data
  • List Player Requests
  • List Stream Hours
  • List Playout Hours
• Revenue
  • List New Subscriptions
  • List Subscription Events
  • List Subscription Revenue
  • List New Transactions
• Engagement
  • Plays
  • Viewers
  • Hours Watched

Why It Matters:
Our new Analytics 3 API allows Zype you to unlock deeper analytics-based insights about content performance and user engagement, streamline data-driven workflows, and take control of your data pipeline by integrating Zype analytics where you need it most.

These new API endpoints are ideal for developers, data teams, and operational teams using Analytics 3 who want to automate reporting, enhance business intelligence tools, or build custom dashboards. The availability of the new API also supports building new data-driven product features, so you could query for custom information like the “Most Popular Video” or “How many hours a given consumer has watched” in a set time frame, for example.

How to Use it: 

To get started using the Zype Analytics 3 API today, you can:

1. Obtain Your API Key by going to Zype Admin > Gear Menu > API Keys, and then create or use an Admin Key with the appropriate Analytics 3 scope
2. Send Authenticated Requests by using the query param ?api_key={YOUR_API_KEY} appended to any analytics API request
   
   Example: https://analytics.zype.com/v3/engagement/plays?api_key=YOUR_API_KEY

For more information on setting up the Analytics 3 API, please refer to this Help Center article Getting Started with the Analytics 3 API.

Availability:
The Analytics 3 API is available now for all customers. To ensure performance and stability across the platform, Zype does enforce rate limits on all Analytics 3 API endpoints to 100 requests per minute per site, with the exception of Stream Hours and Playout Hours that are restricted to 10 requests per minute. 

If your API usage exceeds the specified limit, you will receive a 429 Too Many Requests response.

To avoid disruptions, we recommend following the best practices outlined in our Help Center article, which also includes detailed information on Rate Limits and Data Retention across different endpoint categories.

The legacy Analytics 1 API will remain available, but will be deprecated at a future date. Customers will be notified in advance of Analytics 1 API retirement.

Additional Documentation and Support Resources:
API Documents for the Analytics 3 API can be found in Zype’s API Doc repository. 

Information on how to get started with the Analytics API can be found in the Analytics 3 section in our Help Center: 

• Getting Started with the Analytics 3 API
• Rate Limits and Data Retention
• Real-Time vs Historical Data