Which API to use to get Donor's and Gift's data?

Pradyut Joshi · June 23

Hello

I need to get data for Donors and Gifts, from SKY API.
Does anybody know which API will help me fetch the same?

Thanks in advance!

Bryce Howard · June 23

@Pradyut Joshi
Create a query with your desired output in database or webview. You would probably want to use a gift query. Then use the Query execution job (by ID) endpoint to get the query results as a json or csv.

Alex Wong · June 23

@Pradyut Joshi
this depends on what you are trying to do.

Query API will be able to get you anything you would normally get from database view or webview's Query module, but may not provide some details that would otherwise be useful for complex reporting (i.e. pledge installment, payment, write off)

Pradyut Joshi · June 24

@Alex Wong

Let me give you more details:

I have few metrics based on donor's data and using python, I am using RE's SKY API to fetch data for various objects like constituents, actions, gifts, etc, in the form of JSON and load that data into SQL Server.

But for Donors and Volunteers, I am unable to find any API in the SKY API – both v1 and v2.

Appreciate your help

Alex Wong · June 24

@Pradyut Joshi
donor data has many associated data (i.e. attribute, note, phone/email, address, opportunity, etc), you can check out the API reference and see if it has what you want

https://developer.sky.blackbaud.com/api#api=56b76470069a0509c8f1c5b3&operation=CreateAction

Bryce Howard · June 25

@Alex Wong

Query API will be able to get you anything you would normally get from database view or webview's Query module, but may not provide some details that would otherwise be useful for complex reporting (i.e. pledge installment, payment, write off)

Can you expand more on “may not provide some details”?

The only gift data I know of that can't be pulled from a query output are fields related to adjustments, particularly values from the GIFTHISTORYFIELDS table that store ‘previous’ values. Write-offs have no direct way, but there's a convoluted workaround using a combination of queries.

Alex Wong · June 26

@Bryce Howard
just to be clear, i'm talking about Query module in dbview or webview, not directly running SQL query against the RE database tables, since you cannot do that directly on live RE NXT hosted instance. UNLESS you are talking about a backup copy of RE that you download from Blackbaud and load into your own SQL Server, which then you do not need to use Query API or any API as you can just issue SQL join to get everything.

As for what is not available in Query API (gift query) that is available via “regular” SKY API endpoints:

Pledge Installment system record id (foreign key needed to “be” linked for payment and write off on it)
pledge payment details (this can be payment OR write off): installment system record id the payment is associated to, the pledge gift system record id associated to, the amount from the gift that is associated (i.e. a pay-cash gift of $1000 can be paying $300 to installment 1 of pledge A and $300 to installment 2 of pledge A, and $400 to installment 1 of pledge

The above can be obtained from Gift v2 API to get installemtns and payments detail.

Bryce Howard · June 27

@Alex Wong
Oh gotcha. I was using the SQL table as a refence to all possible gift fields. Those adjustment fields I mentioned, I think are the only ones missing with no workaround. Those adjustment fields I have only found via the pre-built ‘Adjust Gift Report’ in database view, but they don't output as structured data. Thanks for clarifying.

Which API to use to get Donor's and Gift's data?

Comments

Categories