H!HOPPA
GET/api/v2/referrals/metrics

Weekly funnel metrics, credit success rate and contribution.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
programId (query)string (uuid)No
from (query)string (date-time)No
to (query)string (date-time)No

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Weeksarray of ReferralWeeklyMetricResponseYes
CreditsAttemptedunknownYes
CreditsPaidunknownYes
CreditSuccessRateunknownYes
FeesCollectedunknownYes
ProviderCostunknownYes
RewardCostunknownYes
ContributionunknownYes
CurrencystringYes

Example request

curl -X GET "https://{base_url}/api/v2/referrals/metrics" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.