Skip to main content
GET
/
analytics
/
revenue-summary
Company revenue summary
curl --request GET \
  --url https://api.journeybee.io/v1/analytics/revenue-summary \
  --header 'Authorization: Bearer <token>'
{
  "currency_code": "<string>",
  "period": {
    "start_date": "<string>",
    "end_date": "<string>"
  },
  "total_revenue": 123,
  "won_deals": 0,
  "total_deals": 0,
  "avg_deal_value": 123,
  "total_partnerships": 0,
  "total_leads": 0,
  "total_converted_leads": 0,
  "conversion_rate": 123,
  "win_rate": 123,
  "unconverted_deal_count": 0,
  "unconverted_currencies": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Query Parameters

​
period
enum<string>

Reporting period (resolved to a date range server-side). Defaults to current_year. Ignored when start_date + end_date are both supplied.

Available options:
current_year,
last_year,
current_quarter,
last_quarter,
current_month,
last_month,
last_30_days,
last_90_days,
last_6_months,
last_12_months
​
start_date
string

ISO date for a custom range start (use with end_date).

​
end_date
string

ISO date for a custom range end (use with start_date).

​
partner_type
enum<string>

Limit to one partner type; omit to include all partners.

Available options:
referral,
reseller,
distributor
​
lead_direction
enum<string>

For referral partners, which lead direction to count.

Available options:
received,
sent,
all
​
partner_uuids

Restrict to these partnerships (uuids). Pass a single uuid for one partner's scorecard.

​
category_uuids

Restrict to partners in these categories (uuids).

​
tier_uuids

Restrict to partners in these tiers (uuids).

​
stage_uuids

Restrict to partners in these partnership stages (uuids).

​
limit
integer

Max rows for list/leaderboard endpoints (default per endpoint).

Required range: 1 <= x <= 100

Response

200 - application/json

Default Response

​
currency_code
string
required
​
period
object
required
​
total_revenue
number
required
​
won_deals
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
total_deals
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
avg_deal_value
number
required
​
total_partnerships
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
total_leads
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
total_converted_leads
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
conversion_rate
number
required
​
win_rate
number
required
​
unconverted_deal_count
integer
required

Won deals excluded from total_revenue because their currency has no conversion rate to the base currency.

Required range: -9007199254740991 <= x <= 9007199254740991
​
unconverted_currencies
string[]
required

Currency codes that lack a rate to the base currency.