Producer Intelligence API

XP system, achievements, social analytics, contribution graphs, advanced charts, and real-time analytics for producers.

Overview

The Producer Intelligence API is BeatPass’s comprehensive analytics and gamification system for producers. It covers XP tracking, achievements, social analytics, collaboration networks, contribution graphs, advanced charting, and real-time metrics.

Base URL: https://open.beatpass.ca/api/v1/producer-intelligence

Authentication: Public endpoints (leaderboards, batch growth) use optional auth. All other endpoints require a valid Bearer token.

---

Rate Limits

Producer Intelligence endpoints have route-specific rate limits:

Public Endpoints

600/min — Leaderboard, collaboration leaderboard (cached responses)

120/min — Batch growth data (up to 100 tracks per request)

1200/min — Single track growth (prefer batch endpoint)

Authenticated Endpoints

500/min — Dashboard, XP, achievements, progress data, charts, exports

120/min — Social analytics, collaboration network, trending

---

Dashboard & XP

Get Dashboard Data

Comprehensive dashboard data for the authenticated producer.

GET /api/v1/producer-intelligence/dashboard

Get XP Sources

Breakdown of XP earned by source (uploads, plays, engagement, etc.).

GET /api/v1/producer-intelligence/xp-sources

Get Producer Level

Current XP level and progress to next level.

GET /api/v1/producer-intelligence/producer-level

Get Progress Data (Combined)

Optimized combined endpoint that returns dashboard + XP + achievements in a single request. Use this instead of multiple individual calls.

GET /api/v1/producer-intelligence/progress-data

The progress-data endpoint consolidates multiple API calls into one. Use it on dashboard page load to minimize requests and stay within rate limits.

---

Achievements

List Achievements

Get all achievements for the authenticated producer.

GET /api/v1/producer-intelligence/achievements

Get Achievement Details

Get details for a specific achievement.

GET /api/v1/producer-intelligence/achievements/{achievementId}/details

---

Social Analytics

All social analytics endpoints are rate limited to 120 requests/minute.

Social Analytics Overview

Get social engagement metrics (followers, follows, reposts, interactions).

GET /api/v1/producer-intelligence/social-analytics

Social Activity Feed

Get the producer’s recent social activity feed.

GET /api/v1/producer-intelligence/social-activity-feed

Collaboration Network

Map the producer’s collaboration connections.

GET /api/v1/producer-intelligence/collaboration-network

Trending Collaborations

Get trending collaboration pairs on the platform.

GET /api/v1/producer-intelligence/trending-collaborations

Collaboration Opportunities

Get AI-suggested collaboration opportunities based on genre, style, and activity.

GET /api/v1/producer-intelligence/collaboration-opportunities

---

Track Growth

Batch Growth Rates (Recommended)

Get local track trend rates for up to 100 tracks in a single request. Always prefer this over individual calls.

The response includes only tracks that are currently trending. A track must have recent BeatPass play momentum, meet minimum recent-play and distinct-listener thresholds, and outperform the previous comparison window. Tracks that are not trending are omitted from growth_rates.

POST /api/v1/producer-intelligence/tracks/growth-batch

Rate limit: 120 batch requests/minute. Each request can contain up to 100 track IDs.

Single Track Growth (Legacy)

Get the local trend rate for an individual track.

GET /api/v1/producer-intelligence/track/{trackId}/growth

This endpoint has a 1200/min rate limit, but the batch endpoint is strongly recommended for efficiency. Track trend rates are based on local BeatPass play activity, not Spotify popularity or payout contribution values.

---

Leaderboards (Public)

These endpoints are public and cached. Rate limit: 600 requests/minute.

Producer Leaderboard

GET /api/v1/producer-intelligence/leaderboard

Collaboration Leaderboard

GET /api/v1/producer-intelligence/collaboration-leaderboard

---

Contribution Graphs

Artist Contribution Graph

Visualize the contribution graph — the contribution value distribution across an artist’s tracks.

GET /api/v1/producer-intelligence/artist/{artistId}/contribution-graph

Platform Contribution Graph

Platform-wide contribution distribution.

GET /api/v1/producer-intelligence/platform/contribution-graph

---

Advanced Charts

Track Charts

GET /api/v1/producer-intelligence/track/{trackId}/charts

Artist Charts

GET /api/v1/producer-intelligence/artist/{artistId}/charts

Album Charts

GET /api/v1/producer-intelligence/album/{albumId}/charts

Dashboard Charts

Combined chart data for the dashboard view.

GET /api/v1/producer-intelligence/dashboard/charts

Analytics Insights

AI-generated insights about the producer’s performance trends.

GET /api/v1/producer-intelligence/insights

---

Real-Time Analytics

Live Analytics

Get live platform-wide analytics data.

GET /api/v1/producer-intelligence/live-analytics

Real-Time Track Metrics

Get live metrics (active listeners, recent plays) for a specific track.

GET /api/v1/producer-intelligence/track/{trackId}/real-time

---

Export & Reporting

Export to CSV

POST /api/v1/producer-intelligence/export/csv

Export to JSON

POST /api/v1/producer-intelligence/export/json

Generate Report

Generate a comprehensive analytics report.

POST /api/v1/producer-intelligence/report/generate

Export Report as PDF

POST /api/v1/producer-intelligence/report/export-pdf

Get Export Formats

List available export formats.

GET /api/v1/producer-intelligence/export/formats

---

Contribution & Payouts

Endpoints in the Contribution & Payouts and Subscription Payouts sections use different base paths (e.g., /api/v1/producer/, /api/v1/tracks/, /api/v1/artist/) rather than the /api/v1/producer-intelligence/ prefix. Refer to each endpoint’s full path as shown below.

Get Earnings Estimate

GET /api/v1/producer/earnings

Get Track Breakdown

Detailed per-track contribution breakdown.

GET /api/v1/producer/track-breakdown

Get Track Contribution

Contribution value for a specific track.

GET /api/v1/tracks/{track}/contribution

Update My Contributions

Trigger a recalculation of the authenticated producer’s contribution values.

POST /api/v1/producer/update-contributions

Platform Stats

Public platform-wide statistics.

GET /api/v1/platform/stats

Top Tracks

Platform-wide top tracks by contribution value.

GET /api/v1/platform/top-tracks

---

Subscription Payouts

These endpoints are for payout history and summary reporting. They do not set up BEATPAY, change bank details, switch payout providers, or release payouts. Producers manage payout setup in Finances.

List Payouts

Get the authenticated artist’s subscription payout history.

GET /api/v1/artist/subscription-payouts

Payout Summary

Get aggregate payout summary.

GET /api/v1/artist/subscription-payouts/summary

Payout Detail

GET /api/v1/artist/subscription-payouts/{splitId}

---

Best Practices

Use combined endpoints

Use progress-data instead of calling dashboard, xp-sources, and achievements separately.

Use batch track trend endpoint

Use tracks/growth-batch for up to 100 tracks per request instead of individual track/{id}/growth calls. Non-trending tracks are omitted from the response.

Respect cache TTLs

Leaderboard data is cached for 5 minutes. Dashboard data is cached for 15 minutes. Don’t poll faster than these intervals.

Debounce real-time requests

Real-time analytics endpoints are database-intensive. Debounce requests and use appropriate intervals (30s+).

---

Related Resources

Rate Limits

Detailed rate limiting by endpoint group.

Dashboard API

Artist dashboard metrics and profile.

Insights API

Focused insights for tracks, albums, and artists.

Search & Discovery

Leaderboards and discovery features.