> ## Documentation Index > Fetch the complete documentation index at: https://docs.journeybee.io/llms.txt > Use this file to discover all available pages before exploring further. # Partner revenue leaderboard > Partners ranked by revenue for a period, each deal converted to the company base currency. Use this to answer 'best/top partner by revenue/leads/deals' — do NOT list deals and sum them by hand (that mis-handles currencies). Defaults to the current year; pass a `period` or `start_date`+`end_date`. Money is in whole currency units of `currency_code`. ## OpenAPI ````yaml /openapi.json get /analytics/partners openapi: 3.1.0 info: title: Journeybee API description: >- Public REST API for the Journeybee PRM platform. Manage partners, leads, deals, products, pricing calculators, tasks, and more programmatically. All endpoints require authentication via API key. Use `Authorization: Bearer ` or `Api-Key ` header. See the [Authentication guide](/guides/authentication) for details. version: 1.0.0 servers: - url: https://api.journeybee.io/v1 description: Production security: - apiKey: [] tags: - name: Account description: >- Authenticated company account info, API key permissions, and enabled modules - name: Analytics description: >- Dashboard analytics and reporting — commission, engagement, LMS, and partner revenue metrics - name: Assets description: File and media asset management - name: Attributions description: Attribution type definitions - name: Audit Log description: Unified audit log of company activity (read-only) - name: Automations description: Workflow automation rule configurations - name: Campaign Audience description: Audience filters on a campaign - name: Campaign Partners description: Partners shared into a campaign audience - name: Campaigns description: Partner marketing campaigns - name: Card Assignees description: Assigned users on a card - name: Card Partners description: Partners linked to a card - name: Card Tags description: Tags on a card - name: Cards description: Kanban project cards - name: Categories description: Partner categories - name: Certification Categories description: Categories on a certification - name: Certification Enrollments description: User enrollments in a certification - name: Certification Folders description: Folders on a certification - name: Certification Resources description: Curriculum resources in a certification - name: Certifications description: LMS certifications - name: Commissions description: >- Commission rule configurations with calculation entries, tier/category/partnership scoping - name: Contacts description: Partner contacts across partnerships - name: Currencies description: Available currencies - name: Custom Field Options description: Options on select/multi-select custom fields - name: Custom Field Rules description: Visibility and requirement rules on custom fields - name: Custom Field Values description: Custom field values - name: Custom Fields description: Custom field definitions - name: Deal Commission description: Commission calculation on a deal - name: Deal Custom Field Values description: Custom field values on a deal - name: Deal Notes description: Notes on a deal - name: Deal Payments description: Payment records on a deal (read-only) - name: Deal Products description: Products attached to a deal - name: Deal Stages description: Deal pipeline stages - name: Deal Tags description: Tags on a deal - name: Deal Tasks description: Tasks on a deal - name: Deals description: Deal management - name: Folders description: Content folders - name: Lead Attributions description: Attribution records on a lead - name: Lead Contacts description: Partner contacts on a lead - name: Lead Custom Field Values description: Custom field values on a lead - name: Lead Distributor description: Distributors for a lead - name: Lead Notes description: Notes on a lead - name: Lead Products description: Products attached to a lead - name: Lead Quotes description: >- Quotes on a lead — generated from pricing calculators with line items and totals - name: Lead Tags description: Tags on a lead - name: Lead Tasks description: Tasks on a lead - name: Lead Users description: Assigned users on a lead - name: Leads description: Lead management - name: Marketing Templates description: Marketing email templates - name: Partner Contacts description: Contacts on a partner - name: Partner Custom Field Values description: Custom field values on a partner - name: Partner Domains description: Domains on a partner - name: Partner Notes description: Notes on a partner - name: Partner Resellers description: Reseller assignments on a distributor - name: Partner Stages description: Partner pipeline stages - name: Partner Tags description: Tags on a partner - name: Partner Users description: Assigned users on a partner - name: Partners description: Core partner CRUD - name: Pricing Calculator Fields description: Input fields on a pricing calculator - name: Pricing Calculator Formulas description: Discount/tax/surcharge formulas on a pricing calculator - name: Pricing Calculator Products description: Products attached to a pricing calculator - name: Pricing Calculators description: Pricing calculator configurations - name: Products description: Product catalog - name: Resource Blocks description: Content blocks within a resource - name: Resource Categories description: Categories on a resource - name: Resource Folders description: Folders on a resource - name: Resource Tags description: Tags on a resource - name: Resources description: Learning resources - name: Room Blocks description: Content blocks within a room - name: Room Categories description: Category-based room access control - name: Room Partnerships description: Direct partnership room access - name: Room Stages description: Stage-based room access control - name: Room Tags description: Tag-based room access control - name: Room Tiers description: Tier-based room access control - name: Rooms description: Partner portal rooms - name: Tags description: Tag definitions - name: Task Users description: Assigned users on a task - name: Tasks description: Task management - name: Tiers description: Partner tiers - name: Users description: Company team members - name: Webhook Events description: Outbound webhook payloads sent to your configured URLs when events occur paths: /analytics/partners: get: tags: - Analytics summary: Partner revenue leaderboard description: >- Partners ranked by revenue for a period, each deal converted to the company base currency. Use this to answer 'best/top partner by revenue/leads/deals' — do NOT list deals and sum them by hand (that mis-handles currencies). Defaults to the current year; pass a `period` or `start_date`+`end_date`. Money is in whole currency units of `currency_code`. operationId: getPartnerRevenueAnalytics parameters: - schema: type: string enum: - current_year - last_year - current_quarter - last_quarter - current_month - last_month - last_30_days - last_90_days - last_6_months - last_12_months in: query name: period required: false description: >- Reporting period (resolved to a date range server-side). Defaults to current_year. Ignored when start_date + end_date are both supplied. - schema: type: string in: query name: start_date required: false description: ISO date for a custom range start (use with end_date). - schema: type: string in: query name: end_date required: false description: ISO date for a custom range end (use with start_date). - schema: type: string enum: - referral - reseller - distributor in: query name: partner_type required: false description: Limit to one partner type; omit to include all partners. - schema: type: string enum: - received - sent - all in: query name: lead_direction required: false description: For referral partners, which lead direction to count. - schema: anyOf: - type: array items: type: string - type: string in: query name: partner_uuids required: false description: >- Restrict to these partnerships (uuids). Pass a single uuid for one partner's scorecard. - schema: anyOf: - type: array items: type: string - type: string in: query name: category_uuids required: false description: Restrict to partners in these categories (uuids). - schema: anyOf: - type: array items: type: string - type: string in: query name: tier_uuids required: false description: Restrict to partners in these tiers (uuids). - schema: anyOf: - type: array items: type: string - type: string in: query name: stage_uuids required: false description: Restrict to partners in these partnership stages (uuids). - schema: type: integer minimum: 1 maximum: 100 in: query name: limit required: false description: Max rows for list/leaderboard endpoints (default per endpoint). responses: '200': description: Default Response content: application/json: schema: type: object properties: currency_code: type: string period: type: object properties: start_date: type: string end_date: type: string required: - start_date - end_date additionalProperties: false partners: type: array items: type: object properties: uuid: type: string name: anyOf: - type: string - type: 'null' partner_type: type: string enum: - referral - reseller - distributor logo_uuid: anyOf: - type: string - type: 'null' revenue: type: number description: Won-deal revenue in the company base currency. open_pipeline: type: number won_deals: type: integer minimum: -9007199254740991 maximum: 9007199254740991 total_deals: type: integer minimum: -9007199254740991 maximum: 9007199254740991 avg_deal_value: type: number total_leads: type: integer minimum: -9007199254740991 maximum: 9007199254740991 converted_leads: type: integer minimum: -9007199254740991 maximum: 9007199254740991 conversion_rate: type: number description: Converted leads / total leads, percent. win_rate: type: number description: Won deals / total deals, percent. required: - uuid - name - partner_type - logo_uuid - revenue - open_pipeline - won_deals - total_deals - avg_deal_value - total_leads - converted_leads - conversion_rate - win_rate additionalProperties: false required: - currency_code - period - partners additionalProperties: false components: securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ````