Partner Giving Analysis
Partner Giving Analysis Documentation
Partner Giving Analysis [LIST]
Partner Giving Analysis [LIST]
Request
Endpoint
Body
Parameters
Sorts
donation_period_average
Type Unknown
Description Sort contacts by average donation amount
Required No
donation_period_count
Type Unknown
Description Sort contacts by total number of donations in period
Required No
donation_period_percent_rank
Type Unknown
Description Sort contacts by percentage rank of total donations
Required No
donation_period_sum
Type Unknown
Description Sort contacts by total donation amount in period
Required No
first_donation_amount
Type Unknown
Description Sort contacts by first donation amount
Required No
first_donation_date
Type Unknown
Description Sort contacts by first donation date
Required No
last_donation_amount
Type Unknown
Description Sort contacts by last donation amount
Required No
last_donation_date
Type Unknown
Description Sort contacts by last donation date
Required No
name
Type Unknown
Description Sort contacts by name
Required No
total_donations
Type Unknown
Description Sort contacts by total donations
Required No
Filters
account_list_id
Type ID string
Description Filter by Account List; Accepts Account List ID
Required No
address_historic
Type boolean
Description Filter by Address No Longer Valid; Accepts values 'true', or 'false'
Required No
address_lat_lng
Type object with ne and sw lat lng pairs
Description Filter contacts with addresses located within the lat lng bounds. Hash should contain a ne and sw lat lng pair.
Required No
address_valid
Type boolean
Description Filter where address value is false; accepts "false"
Required No
alma_mater
Type string
Description Filter by alma mater; Accepts multiple parameters, with value 'none', or an alma mater name
Required No
anniversary
Type string
Description Filter where contact people have anniversary on date between provided date range
Required No
any_tags
Type boolean
Description When filtering by tags this specifies if the filter should match tasks with any of the filtered tags if "true" or only tasks with all of the filtered tags if "false"
Required No
appeal
Type ID string
Description Filter by Appeal; Accepts multiple parameters, with value 'no_appeals', or an appeal ID
Required No
appeal_status
Type ID string
Description Filter by Pledge Status. One of excluded, asked, not_received, received_not_processed, or processed. Must be used with appeal filter.
Required No
birthday
Type string
Description Filter where contact people have birthday on date between provided date range
Required No
church
Type string
Description Filter by Church; Accepts multiple parameters, with value 'none', or a church name
Required No
city
Type string
Description Filter by City; Accepts multiple parameters, with value 'none', or a city name
Required No
contact_info_addr
Type string
Description Filter by where contact has address; Accepts values 'Yes', or 'No'
Required No
contact_info_email
Type string
Description Filter where contact people has an email; Accepts values 'Yes', or 'No'
Required No
contact_info_facebook
Type string
Description Filter where contact people has a Facebook Profile; Accepts values 'Yes', or 'No'
Required No
contact_info_mobile
Type string
Description Filter where contact people has a mobile phone; Accepts values 'Yes', or 'No'
Required No
contact_info_phone
Type string
Description Filter where contact people has a phone; Accepts values 'Yes', or 'No'
Required No
contact_info_work_phone
Type string
Description Filter where contact people has a work phone; Accepts values 'Yes', or 'No'
Required No
contact_type
Type string
Description Filter by Type; Accepts multiple parameters, with values 'person', and 'company'
Required No
country
Type string
Description Filter by Country; Accepts multiple parameters, with values 'none', or a country
Required No
created_at
Type date
Description Filter contacts that were created in this date range
Required No
designation_account_id
Type string
Description Filter by Designation Account; accepts multiple parameters, separated by comma
Required No
donation
Type string
Description Filter by Gift Options; Accepts multiple parameters, with values 'none', 'one', 'first', and 'last'
Required No
donation_amount
Type string
Description Filter by Exact Gift Amount; Accepts multiple parameters, with values like '9.99'
Required No
donation_amount_range
Type Object
Description Filter by Gift Amount Range; Accepts object with max and min keys with decimal values { "max": "9.99", "min": "0.99" }
Required No
donation_date
Type string
Description Filter by Gift Date; Accepts date range with text value like 'MM/DD/YYYY - MM/DD/YYYY'
Required No
donation_period_average
Type Object
Description Filters by donation period count; Accepts hash with min and max decimal values
Required No
donation_period_count
Type Object
Description Filters by donation period count; Accepts hash with min and max decimal values
Required No
donation_period_percent_rank
Type Object
Description Filters by donation period count; Accepts hash with min and max decimal values
Required No
donation_period_sum
Type Object
Description Filters by donation period count; Accepts hash with min and max decimal values
Required No
exclude_tags
Type string
Description Filter contacts that have any of the tags included in this filter; comma separated value for multiple
Required No
gave_more_than_pledged_range
Type date
Description Filter where contact gave more than they pledged within the provided date range
Required No
ids
Type ID string
Description Filter contacts with ids included in this filter; comma separated value for multiple
Required No
late_at
Type Unknown
Description Filter contacts by the date at which the contact started being late on payments
Required No
likely
Type string
Description Filter by Likely To Give; Accepts multiple parameters, with values 'none', 'Least Likely', 'Likely', and 'Most Likely'
Required No
locale
Type string
Description Filter by Language; Accepts multiple parameters,
Required No
metro_area
Type string
Description Filter by Metro Area; Accepts multiple parameters, with values 'none', or a metro area name
Required No
name_like
Type string
Description Filter where contact name starts with the provided value
Required No
newsletter
Type string
Description Filter by Newsletter Recipients; Accepts values 'none', 'all', 'address', 'email', and 'both'
Required No
next_ask
Type string
Description Filter by Next Ask date within the provided date range
Required No
no_appeals
Type boolean
Description Filter where contact has asked specifically not to receive appeals; accepts "true"
Required No
not_ids
Type ID string
Description Filter where contact id is not apart of the provided list of ids; accepts comma separated ids
Required No
notes
Type string
Description Filter contacts with note contents; accepts hash with wildcard_note_search parameter { "wildcard_note_search": "value to search by" }
Required No
opt_out
Type string
Description Filter where at least one contact person has opted out from email; Accepts values 'Yes', or 'No'
Required No
organization_id
Type ID string
Description filter where contact's account list has a designation account belonging to an organization; Accepts IDs separated by comma
Required No
pledge
Type string
Description Filter contacts by pledge status. completed, outstanding, pending
Required No
pledge_amount
Type string
Description Filter by Pledge Amount; Accepts multiple parameters, with values like '100.0'
Required No
pledge_amount_increased_range
Type date
Description Filter where Pledge Amount increased in the provided date range
Required No
pledge_currency
Type string
Description Filter by Pledge Currency; Accepts multiple parameters, with values like 'USD'
Required No
pledge_frequency
Type string
Description Filter by Pledge Frequency; Accepts multiple parameters, with numeric values like '0.23076923076923' (Weekly), '0.46153846153846' (Every 2 Weeks), '1.0' (Monthly), '2.0' (Every 2 Months), '3.0', '4.0', '6.0', '12.0' (Yearly), and '24.0' (Every 2 Years)
Required No
pledge_late_by
Type string
Description Filter by Late By; Accepts values '', '0_30' (Less than 30 days late), '30_60' (More than 30 days late), '60_90' (More than 60 days late), or '90' (More than 90 days late)
Required No
pledge_received
Type string
Description Filter by Pledge Received; Accepts values 'true', or 'false'
Required No
primary_address
Type string
Description Filter contacts with addresses in particular state; accepts comma separated values of either 'primary', 'active', 'inactive', 'null'
Required No
referrer
Type string
Description Filter by Referrer; Accepts multiple parameters, with values 'none', 'any', or a Contact ID
Required No
referrer_ids
Type Unknown
Description Filter by Referrer ID; Accepts Comma separated list of Contact IDs
Required No
region
Type string
Description Filter by Region; Accepts multiple parameters, with values 'none', or a region name
Required No
related_task_action
Type string
Description Filter by Action; Accepts multiple parameters, with values 'none', or an activity type like 'Call'
Required No
source
Type string
Description Filter by Source; Accepts multiple parameters
Required No
starred
Type string
Description Filter by starred, is either selected or unselected
Required No
started_giving_range
Type date
Description Filter where contact started giving in the provided date range
Required No
state
Type string
Description Filter by State; Accepts multiple parameters, with values 'none', or a state
Required No
status
Type string
Description Filter by Status; Accepts multiple parameters, with values 'active', 'hidden', 'null', 'Never Contacted', 'Ask in Future', 'Cultivate Relationship', 'Contact for Appointment', 'Appointment Scheduled', 'Call for Decision', 'Partner - Financial', 'Partner - Special', 'Partner - Pray', 'Not Interested', 'Unresponsive', 'Never Ask', 'Research Abandoned', and 'Expired Referral'
Required No
status_valid
Type string
Description Filter by Status Valid; Accepts values 'true', or 'false'
Required No
stopped_giving_range
Type date
Description Filter where contact stopped giving in the provided date range
Required No
tags
Type string
Description Filter by Tags; Accepts multiple parameters, with text values separated by comma
Required No
task_due_date
Type string
Description Filter by Due Date; Accepts date range with text value like 'MM/DD/YYYY - MM/DD/YYYY'
Required No
tasks_all_completed
Type boolean
Description Filter where contact's tasks have completed set to true; accepts "true"
Required No
timezone
Type string
Description Filter by Timezone; Accepts multiple parameters
Required No
updated_at
Type date
Description Filter contacts that were updated in this date range
Required No
user_ids
Type ID string
Description Filter contacts with user_ids included in this filter; comma separated value for multiple
Required No
wildcard_search
Type string
Description Filter contacts where name contains this filter
Required No
Response
Headers
Body
Fields
data
Type
[Contact]
Description An array of Contacts
Last updated