SparkLoop
  • API v2
    • Endpoints
      • Subscribers
        • Events
      • Referral Campaigns
        • Campaign Memberships
        • Subscribers
      • Partner Profile
        • Recommendations
        • Payouts
      • Publications
      • Upscribe
        • Recommendations
      • Partner Programs
      • Partner Network
        • Publications
        • Partner Programs
      • Webhooks
    • Schemas
      • Partner Profile Object
      • Partner Program Object
      • Publication Object
      • Subscriber Object
      • Campaign Object
      • Upscribe Object
      • Recommendation Object
    • Guides
      • How to use Upscribe via API
  • API v1
    • Campaigns
    • Subscribers
    • Events
    • Webhooks
  • Webhooks
  • Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API v2
  2. Schemas

Recommendation Object

Example

{
  "uuid": "partner_campaign_23ac0811bfff",
  "type": "paid",
  "status": "active",
  "ref_code": "14ea515235",
  "publication_name": "Create&Sell",
  "publication_logo": "https://dash.sparkloop.app/rails/active_storage/representations/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBUQT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--09ff9f6a380f9932f80a7f6cce84d99bcfb8dd77/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCam9VY21WemFYcGxYM1J2WDJ4cGJXbDBXd2RwQWl3QmFRSXNBUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--a16f10a9081f2638d20a91ffaaa5e704ddf0529c/evaddon-v7-logo-circle-512px.png",
  "partner_program_uuid": "partner_program_83ba92h24",
  "description": "Weekly, in-depth email marketing advice for creators by email genius Brennan Dunn.",
  "cpa": 300,
  "max_payout": 150000,
  "referral_pending_duration": 10,
  "last_30_days_confirmation_rate": 1,
  "can_be_recommended_via": ["upscribe"],
  "position": null,
  "pinned": false,
  "referrals": {
    "pending": 541,
    "rejected": 38,
    "confirmed": 2890
  },
  "earnings": 867000
}
Property
Type
Description

uuid

string

Recommendation's UUID

type

string

Type of recommendation. Can be "paid" or "free".

status

string

Recommendation's status. Can be "active" or "paused".

publication_name

string

Publication's name

publication_logo

string

Publication's logo

partner_program_uuid

string

The recommendation's partner program UUID.

description

string

Recommendation's reason

cpa

integer

How much partners earn for sending confirmed referrals in cents.

pinned

boolean

Whether or not the recommendation is pinned in Upscribe. When a recommendation is pinned it is always shown, unless it has run out of budget or the location of the subscriber is not suitable for it.

referrals

object

Breakdown of all time pending/rejected/confirmed referrals

earnings

integer

All time earnings in cents

max_payout

float

the max amount a partner can earn per month in cents

position

integer

the position of the recommendation

earnings

integer

all time earnings

can_be_recommended_via

array

list of channels that can be used to recommend upscribe/magic_link/partner_link

last_30_days_confirmation_rate

integer

Last 30 days referral confirmation rate

PreviousUpscribe ObjectNextGuides

Last updated 1 year ago

Was this helpful?