FirstPromoter Connector Reference

20 metrics101 dimensions

The FirstPromoter connector exposes 121 fields (20 metrics, 101 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.


FirstPromoter Fields

FirstPromoter commission fields

The commission report of the FirstPromoter connector includes 9 fields.

IDTypeNameDescription
commissions__amountNUMERICFP Commission AmountThe amount of the commission
commissions__created_atTIMESTAMPCommission Created AtWhen the commission was created
commissions__idTEXTCommission IDThe unique ID of the commission
commissions__is_paidBOOLEANIs PaidWhether the commission has been paid
commissions__original_sale_amountNUMERICFP Original Sale AmountThe original sale amount before any adjustments
commissions__sale_amountNUMERICFP Sale AmountThe sale amount that generated the commission
commissions__statusTEXTFP Commission StatusThe status of the commission (pending, approved, etc.)
commissions__status_updated_atTIMESTAMPCommission Status Updated AtWhen the commission status was last updated
commissions__typeTEXTFP Commission TypeThe type of commission (sale, tier, etc.)

FirstPromoter payout fields

The payout report of the FirstPromoter connector includes 25 fields.

IDTypeNameDescription
payouts__amountNUMERICFP Payout AmountThe amount of the payout
payouts__campaign_colorTEXTPayout Campaign ColorThe color of the campaign associated with the payout
payouts__campaign_idNUMERICPayout Campaign IDThe ID of the campaign associated with the payout
payouts__campaign_nameTEXTPayout Campaign NameThe name of the campaign associated with the payout
payouts__created_atTIMESTAMPPayout Created AtWhen the payout was created
payouts__errorTEXTPayout ErrorError message if payout failed
payouts__failed_atTIMESTAMPPayout Failed AtWhen the payout failed
payouts__idTEXTFirstPromoter Payout IDThe unique ID of the payout
payouts__invoice_idNUMERICPayout Invoice IDThe ID of the invoice associated with the payout
payouts__invoice_numberTEXTPayout Invoice NumberThe number of the invoice associated with the payout
payouts__method_idNUMERICPayout Method IDThe ID of the payout method
payouts__method_is_disabledBOOLEANPayout Method DisabledWhether the payout method is disabled
payouts__method_methodTEXTPayout Method TypeThe type of payout method
payouts__paid_atTIMESTAMPPayout Paid AtWhen the payout was paid
payouts__payments_batch_idNUMERICPayout Payments Batch IDThe payments batch ID for the payout
payouts__period_endDATEPayout Period EndThe end date of the payout period
payouts__period_startDATEPayout Period StartThe start date of the payout period
payouts__processing_started_atTIMESTAMPPayout Processing Started AtWhen payout processing started
payouts__promoter_emailTEXTPayout Promoter EmailThe email of the promoter receiving the payout
payouts__promoter_idNUMERICPayout Promoter IDThe ID of the promoter receiving the payout
payouts__promoter_nameTEXTPayout Promoter NameThe name of the promoter receiving the payout
payouts__statusTEXTPayout StatusThe status of the payout (pending, completed, failed, etc.)
payouts__tax_rateNUMERICPayout Tax RateThe tax rate applied to the payout
payouts__total_incl_taxNUMERICPayout Total Including TaxThe total payout amount including tax
payouts__unitTEXTPayout UnitThe unit/currency of the payout

FirstPromoter promoter fields

The promoter report of the FirstPromoter connector includes 14 fields.

IDTypeNameDescription
promoter__archived_atTIMESTAMPArchived AtWhen the promoter was archived
promoter__customer_idTEXTPromoter Customer IDThe customer ID of the promoter
promoter__emailTEXTPromoter EmailThe email address of the promoter
promoter__first_event_atTIMESTAMPFirst Event AtWhen the first event occurred for the promoter
promoter__fraud_suspicionsTEXTFraud SuspicionsArray of fraud suspicion indicators for the promoter
promoter__idTEXTPromoter IDThe unique ID of the promoter
promoter__invoice_details_statusTEXTInvoice Details StatusThe status of invoice details
promoter__is_confirmedBOOLEANIs ConfirmedWhether the promoter is confirmed
promoter__is_customizedBOOLEANIs CustomizedWhether the promoter profile is customized
promoter__joined_atTIMESTAMPJoined AtWhen the promoter joined
promoter__last_login_atTIMESTAMPLast Login AtWhen the promoter last logged in
promoter__nameTEXTNameThe name of the promoter
promoter__noteTEXTNoteNotes about the promoter
stateTEXTStateThe state of the promoter (pending, active, etc.)

FirstPromoter promoter_campaign fields

The promoter_campaign report of the FirstPromoter connector includes 8 fields.

IDTypeNameDescription
promoter__campaign_colorTEXTPromoter Campaign ColorThe color of the campaign associated with the promoter
promoter__campaign_couponTEXTPromoter Campaign CouponThe coupon code for the promoter campaign
promoter__campaign_created_atTIMESTAMPPromoter Campaign Created AtWhen the promoter campaign association was created
promoter__campaign_idTEXTPromoter Campaign IDThe ID of the campaign associated with the promoter
promoter__campaign_nameTEXTPromoter Campaign NameThe name of the campaign associated with the promoter
TEXTPromoter Campaign Reference LinkThe reference link for the promoter campaign
promoter__campaign_reference_tokenTEXTPromoter Campaign Reference TokenThe reference token for the promoter campaign
promoter__campaign_stateTEXTPromoter Campaign StateThe state of the campaign for the promoter

FirstPromoter promoter_profile fields

The promoter_profile report of the FirstPromoter connector includes 23 fields.

IDTypeNameDescription
promoter__profile_addressTEXTPromoter AddressThe address of the promoter
promoter__profile_avatarTEXTPromoter Avatar URLThe avatar URL of the promoter
promoter__profile_company_nameTEXTPromoter Company NameThe company name of the promoter
promoter__profile_company_numberTEXTPromoter Company NumberThe company number of the promoter
promoter__profile_countryCOUNTRYPromoter CountryThe country of the promoter
promoter__profile_descriptionTEXTPromoter DescriptionThe description of the promoter
promoter__profile_facebook_urlTEXTPromoter Facebook URLThe Facebook URL of the promoter
promoter__profile_first_nameTEXTPromoter First NameThe first name of the promoter
promoter__profile_idTEXTPromoter Profile IDThe ID of the promoter profile
promoter__profile_instagram_urlTEXTPromoter Instagram URLThe Instagram URL of the promoter
promoter__profile_invoice_details_validation_errorsTEXTPromoter Invoice Details Validation ErrorsValidation errors for the promoter's invoice details
promoter__profile_last_nameTEXTPromoter Last NameThe last name of the promoter
promoter__profile_linkedin_urlTEXTPromoter LinkedIn URLThe LinkedIn URL of the promoter
promoter__profile_phoneTEXTPromoter Phone NumberThe phone number of the promoter
promoter__profile_should_validate_invoice_detailsBOOLEANPromoter Should Validate Invoice DetailsWhether invoice details should be validated for this promoter
promoter__profile_tiktok_urlTEXTPromoter TikTok URLThe TikTok URL of the promoter
promoter__profile_twitch_urlTEXTPromoter Twitch URLThe Twitch URL of the promoter
promoter__profile_twitter_urlTEXTPromoter Twitter URLThe Twitter URL of the promoter
promoter__profile_vat_idTEXTPromoter VAT IDThe VAT ID of the promoter
promoter__profile_w8_form_urlTEXTPromoter W8 Form URLThe URL to the promoter's W8 form
promoter__profile_w9_form_urlTEXTPromoter W9 Form URLThe URL to the promoter's W9 form
promoter__profile_websiteTEXTPromoter WebsiteThe website of the promoter
promoter__profile_youtube_urlTEXTPromoter YouTube URLThe YouTube URL of the promoter

FirstPromoter promoter_stats fields

The promoter_stats report of the FirstPromoter connector includes 6 fields.

IDTypeNameDescription
revenue_amountNUMERICRevenue AmountTotal revenue generated by the promoter
stats_active_customers_countNUMERICActive Customers CountNumber of active customers referred by the promoter
stats_clicks_countNUMERICClicks CountNumber of clicks generated by the promoter
stats_customers_countNUMERICCustomers CountNumber of customers referred by the promoter
stats_referrals_countNUMERICReferrals CountNumber of referrals generated by the promoter
stats_sales_countNUMERICSales CountNumber of sales generated by the promoter

FirstPromoter referral fields

The referral report of the FirstPromoter connector includes 15 fields.

IDTypeNameDescription
referrals__campaign_idNUMERICReferral Campaign IDThe campaign ID associated with this referral
referrals__campaign_nameTEXTReferral Campaign NameThe name of the campaign associated with this referral
referrals__created_atTIMESTAMPReferral Created AtWhen the referral was created
referrals__created_by_user_emailTEXTReferral Created By User EmailEmail of the user who created this referral
referrals__customer_sinceDATEReferral Customer SinceWhen the referred user became a customer
referrals__emailTEXTReferral EmailThe email address of the referred customer
referrals__entry_sourceTEXTReferral Entry SourceHow the referral was created (api, manual, etc.)
referrals__fraud_checkTEXTReferral Fraud CheckThe fraud check status of the referral
referrals__idTEXTReferral IDThe unique ID of the referral
referrals__promoter_campaign_idNUMERICReferral Promoter Campaign IDDirect reference to the promoter ID in the campaign
referrals__promoter_emailTEXTReferral Promoter EmailThe email address of the promoter who generated this referral
referrals__promoter_idNUMERICReferral Promoter IDThe unique ID of the promoter who generated this referral
referrals__promoter_nameTEXTReferral Promoter NameThe name of the promoter who generated this referral
referrals__stateTEXTReferral StateThe state of the referral (subscribed, active, cancelled, etc.)
referrals__uidTEXTReferral UIDThe unique identifier of the referred customer

FirstPromoter other fields

The FirstPromoter connector has 21 fields that do not belong to a named report, or belong to a report with only one or two fields.

IDTypeNameDescriptionReport
account_idTEXTAccount IDThe FirstPromoter account IDaccount
account_nameTEXTAccount NameThe FirstPromoter account nameaccount
data_fetched_atTIMESTAMPData fetched atUTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateGeneric date field in yyyy-mm-dd format. For promoters: joined date, for commissions/payouts/referrals: created date
day_of_monthTEXTDay of monthDay of the month
monthTEXTMonthNumber of the month
nowTIMESTAMPNowCurrent timestamp
sourceTEXTSourceThe name of the Windsor connector returning the row
todayDATETodayToday's date
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_month_nameTEXTYear month nameYear and month with the month name written out, e.g. "Jan 2025".
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20