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

Subscriber Object

Example

{
  "uuid": "sub_4bc1056297",
  "email": "drago@sparkloop.app",
  "name": null,
  "ref_code": "c784ef4f",
  "referrer_code": null,
  "referred": true,
  "referral_status": "verified",
  "ip_address": null,
  "user_agent": null,
  "origin": "signup",
  "country_code": "US",
  "cpa": 5.0,
  "utm_source": null,
  "utm_campaign": null,
  "created_at": "2021-03-24T11:55:02.113Z"
}
Property
Type
Description

uuid

string

the unique ID of the subscriber

email

string

the email address of the subscriber

name

string

the name of the subscriber

ref_code

string

the referral code of the subscriber

referrer_code

string

the referral code of the subscriber's referrer

referred

boolean

flag to indicate whether this subscriber was referred

referral_status

string

the referral status of the subscriber. Possible values: verified, pending, rejected.

ip_address

string

the ip address of the subscriber

user_agent

string

the user agent of the subscriber

origin

string

the origin of the subscriber. For example: "signup", "sparkloop-upscribe", etc

cpa

float

the cpa of the subscriber (for subscribers acquired via paid channels only)

utm_source

string

the acquisition source of the subscriber

utm_campaign

string

the acquistion campaign of the subscriber

created_at

timestamp

the date the subscriber was created

PreviousPublication ObjectNextCampaign Object

Last updated 1 year ago

Was this helpful?