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.

ID Type Name Description
commissions__amount NUMERIC FP Commission Amount The amount of the commission
commissions__created_at TIMESTAMP Commission Created At When the commission was created
commissions__id TEXT Commission ID The unique ID of the commission
commissions__is_paid BOOLEAN Is Paid Whether the commission has been paid
commissions__original_sale_amount NUMERIC FP Original Sale Amount The original sale amount before any adjustments
commissions__sale_amount NUMERIC FP Sale Amount The sale amount that generated the commission
commissions__status TEXT FP Commission Status The status of the commission (pending, approved, etc.)
commissions__status_updated_at TIMESTAMP Commission Status Updated At When the commission status was last updated
commissions__type TEXT FP Commission Type The type of commission (sale, tier, etc.)

FirstPromoter payout fields

The payout report of the FirstPromoter connector includes 25 fields.

ID Type Name Description
payouts__amount NUMERIC FP Payout Amount The amount of the payout
payouts__campaign_color TEXT Payout Campaign Color The color of the campaign associated with the payout
payouts__campaign_id NUMERIC Payout Campaign ID The ID of the campaign associated with the payout
payouts__campaign_name TEXT Payout Campaign Name The name of the campaign associated with the payout
payouts__created_at TIMESTAMP Payout Created At When the payout was created
payouts__error TEXT Payout Error Error message if payout failed
payouts__failed_at TIMESTAMP Payout Failed At When the payout failed
payouts__id TEXT FirstPromoter Payout ID The unique ID of the payout
payouts__invoice_id NUMERIC Payout Invoice ID The ID of the invoice associated with the payout
payouts__invoice_number TEXT Payout Invoice Number The number of the invoice associated with the payout
payouts__method_id NUMERIC Payout Method ID The ID of the payout method
payouts__method_is_disabled BOOLEAN Payout Method Disabled Whether the payout method is disabled
payouts__method_method TEXT Payout Method Type The type of payout method
payouts__paid_at TIMESTAMP Payout Paid At When the payout was paid
payouts__payments_batch_id NUMERIC Payout Payments Batch ID The payments batch ID for the payout
payouts__period_end DATE Payout Period End The end date of the payout period
payouts__period_start DATE Payout Period Start The start date of the payout period
payouts__processing_started_at TIMESTAMP Payout Processing Started At When payout processing started
payouts__promoter_email TEXT Payout Promoter Email The email of the promoter receiving the payout
payouts__promoter_id NUMERIC Payout Promoter ID The ID of the promoter receiving the payout
payouts__promoter_name TEXT Payout Promoter Name The name of the promoter receiving the payout
payouts__status TEXT Payout Status The status of the payout (pending, completed, failed, etc.)
payouts__tax_rate NUMERIC Payout Tax Rate The tax rate applied to the payout
payouts__total_incl_tax NUMERIC Payout Total Including Tax The total payout amount including tax
payouts__unit TEXT Payout Unit The unit/currency of the payout

FirstPromoter promoter fields

The promoter report of the FirstPromoter connector includes 14 fields.

ID Type Name Description
promoter__archived_at TIMESTAMP Archived At When the promoter was archived
promoter__customer_id TEXT Promoter Customer ID The customer ID of the promoter
promoter__email TEXT Promoter Email The email address of the promoter
promoter__first_event_at TIMESTAMP First Event At When the first event occurred for the promoter
promoter__fraud_suspicions TEXT Fraud Suspicions Array of fraud suspicion indicators for the promoter
promoter__id TEXT Promoter ID The unique ID of the promoter
promoter__invoice_details_status TEXT Invoice Details Status The status of invoice details
promoter__is_confirmed BOOLEAN Is Confirmed Whether the promoter is confirmed
promoter__is_customized BOOLEAN Is Customized Whether the promoter profile is customized
promoter__joined_at TIMESTAMP Joined At When the promoter joined
promoter__last_login_at TIMESTAMP Last Login At When the promoter last logged in
promoter__name TEXT Name The name of the promoter
promoter__note TEXT Note Notes about the promoter
state TEXT State The state of the promoter (pending, active, etc.)

FirstPromoter promoter_campaign fields

The promoter_campaign report of the FirstPromoter connector includes 8 fields.

ID Type Name Description
promoter__campaign_color TEXT Promoter Campaign Color The color of the campaign associated with the promoter
promoter__campaign_coupon TEXT Promoter Campaign Coupon The coupon code for the promoter campaign
promoter__campaign_created_at TIMESTAMP Promoter Campaign Created At When the promoter campaign association was created
promoter__campaign_id TEXT Promoter Campaign ID The ID of the campaign associated with the promoter
promoter__campaign_name TEXT Promoter Campaign Name The name of the campaign associated with the promoter
TEXT Promoter Campaign Reference Link The reference link for the promoter campaign
promoter__campaign_reference_token TEXT Promoter Campaign Reference Token The reference token for the promoter campaign
promoter__campaign_state TEXT Promoter Campaign State The state of the campaign for the promoter

FirstPromoter promoter_profile fields

The promoter_profile report of the FirstPromoter connector includes 23 fields.

ID Type Name Description
promoter__profile_address TEXT Promoter Address The address of the promoter
promoter__profile_avatar TEXT Promoter Avatar URL The avatar URL of the promoter
promoter__profile_company_name TEXT Promoter Company Name The company name of the promoter
promoter__profile_company_number TEXT Promoter Company Number The company number of the promoter
promoter__profile_country COUNTRY Promoter Country The country of the promoter
promoter__profile_description TEXT Promoter Description The description of the promoter
promoter__profile_facebook_url TEXT Promoter Facebook URL The Facebook URL of the promoter
promoter__profile_first_name TEXT Promoter First Name The first name of the promoter
promoter__profile_id TEXT Promoter Profile ID The ID of the promoter profile
promoter__profile_instagram_url TEXT Promoter Instagram URL The Instagram URL of the promoter
promoter__profile_invoice_details_validation_errors TEXT Promoter Invoice Details Validation Errors Validation errors for the promoter's invoice details
promoter__profile_last_name TEXT Promoter Last Name The last name of the promoter
promoter__profile_linkedin_url TEXT Promoter LinkedIn URL The LinkedIn URL of the promoter
promoter__profile_phone TEXT Promoter Phone Number The phone number of the promoter
promoter__profile_should_validate_invoice_details BOOLEAN Promoter Should Validate Invoice Details Whether invoice details should be validated for this promoter
promoter__profile_tiktok_url TEXT Promoter TikTok URL The TikTok URL of the promoter
promoter__profile_twitch_url TEXT Promoter Twitch URL The Twitch URL of the promoter
promoter__profile_twitter_url TEXT Promoter Twitter URL The Twitter URL of the promoter
promoter__profile_vat_id TEXT Promoter VAT ID The VAT ID of the promoter
promoter__profile_w8_form_url TEXT Promoter W8 Form URL The URL to the promoter's W8 form
promoter__profile_w9_form_url TEXT Promoter W9 Form URL The URL to the promoter's W9 form
promoter__profile_website TEXT Promoter Website The website of the promoter
promoter__profile_youtube_url TEXT Promoter YouTube URL The YouTube URL of the promoter

FirstPromoter promoter_stats fields

The promoter_stats report of the FirstPromoter connector includes 6 fields.

ID Type Name Description
revenue_amount NUMERIC Revenue Amount Total revenue generated by the promoter
stats_active_customers_count NUMERIC Active Customers Count Number of active customers referred by the promoter
stats_clicks_count NUMERIC Clicks Count Number of clicks generated by the promoter
stats_customers_count NUMERIC Customers Count Number of customers referred by the promoter
stats_referrals_count NUMERIC Referrals Count Number of referrals generated by the promoter
stats_sales_count NUMERIC Sales Count Number of sales generated by the promoter

FirstPromoter referral fields

The referral report of the FirstPromoter connector includes 15 fields.

ID Type Name Description
referrals__campaign_id NUMERIC Referral Campaign ID The campaign ID associated with this referral
referrals__campaign_name TEXT Referral Campaign Name The name of the campaign associated with this referral
referrals__created_at TIMESTAMP Referral Created At When the referral was created
referrals__created_by_user_email TEXT Referral Created By User Email Email of the user who created this referral
referrals__customer_since DATE Referral Customer Since When the referred user became a customer
referrals__email TEXT Referral Email The email address of the referred customer
referrals__entry_source TEXT Referral Entry Source How the referral was created (api, manual, etc.)
referrals__fraud_check TEXT Referral Fraud Check The fraud check status of the referral
referrals__id TEXT Referral ID The unique ID of the referral
referrals__promoter_campaign_id NUMERIC Referral Promoter Campaign ID Direct reference to the promoter ID in the campaign
referrals__promoter_email TEXT Referral Promoter Email The email address of the promoter who generated this referral
referrals__promoter_id NUMERIC Referral Promoter ID The unique ID of the promoter who generated this referral
referrals__promoter_name TEXT Referral Promoter Name The name of the promoter who generated this referral
referrals__state TEXT Referral State The state of the referral (subscribed, active, cancelled, etc.)
referrals__uid TEXT Referral UID The 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.

ID Type Name Description Report
account_id TEXT Account ID The FirstPromoter account ID account
account_name TEXT Account Name The FirstPromoter account name account
data_fetched_at TIMESTAMP Data fetched at UTC 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.
datasource TEXT Data Source The name of the Windsor connector returning the row
date DATE Date Generic date field in yyyy-mm-dd format. For promoters: joined date, for commissions/payouts/referrals: created date
day_of_month TEXT Day of month Day of the month
month TEXT Month Number of the month
now TIMESTAMP Now Current timestamp
source TEXT Source The name of the Windsor connector returning the row
today DATE Today Today's date
week TEXT Week Week (Sun-Sat).
week_day TEXT Day of week and day number Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_iso TEXT Day of week and day number, ISO Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_iso TEXT Week ISO Week, ISO format (Mon-Sun).
year TEXT Year Year
year_month TEXT Yearmonth Year and month, e.g. 2024|3
year_month_name TEXT Year month name Year and month with the month name written out, e.g. "Jan 2025".
year_of_week TEXT Year of week The year that contains first day of the week (Sun-Sat).
year_of_week_iso TEXT Year of week, ISO The year that contains first day of the ISO week (Mon-Sun).
year_week TEXT Year week Year and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_iso TEXT Year week ISO Year and week for ISO weeks (Mon-Sun), e.g. 2024|20