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/.../logo.png",
  "description": "Weekly, in-depth email marketing advice for creators by email genius Brennan Dunn.",
  "pinned": false,
  "position": null,
  "max_payout": 150000,
  "last_30_days_confirmation_rate": 30,
  "signup_url": "https://recs.page/create-and-sell?ref_code=14ea515235",
  "partner_program_uuid": "partner_program_83ba92h24",
  "available_budget_dollars": 100000,
  "cpa": 300,
  "referrals": {
    "pending": 541,
    "rejected": 38,
    "confirmed": 2890
  },
  "earnings": 867000,
  "net_earnings": 800000
}
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", "archived" or "paused". Referrals can only be sent to active recommendations.

ref_code

string

Randomly generated hex string representing the recommendation. Used for the signup URL.

publication_name

string

Publication's name

publication_logo

string

Publication's logo URL

description

string

Recommendation's description or reason to recommend

signup_url

string

Link to SparkLoop's Recommendations Hub Direct SignUp Page where the subscriber can opt into the recommended publication's newsletter. An email query parameter can be prepended to the URL to enable 1-click subscription.

cpa

integer

How much partners earn for sending confirmed referrals in cents.

pinned

boolean

Whether or not the recommendation is pinned. 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.

position

integer

The position of the recommendation

partner_program_uuid

string

The recommendation's partner program UUID.

max_payout

integer

The max amount a partner can earn per month in cents

available_budget

integer

Monthly budget left before hitting the max_payout, in cents. When it reaches 0, the recommendation budget will be considered exhausted and referrals won't be paid for.

referrals

object

Breakdown of all time pending/rejected/confirmed referrals

last_30_days_confirmation_rate

integer

Last 30 days referral confirmation rate

earnings

integer

All time gross earnings in cents

net_earnings

integer

All time net earnings in cents, after SparkLoop & payment processing fees

Last updated