[API] Get total sponsorships from a sponsor to a sponsorable

[pomber]

Select Topic Area

Question

Body

As a sponsorable organization, I would like to know how much each sponsor sponsored my org in total.

Currently, I'm using the CSV exported from the dashboard (grouping by Sponsor Handle and summing Processed Amount). But it's a manual process and I need to automate it.

I tried a couple of things from https://github.com/orgs/community/discussions/3818 without success.

Is it possible to use the API to get the transactions similar to what the exported CSV provides? Or another alternative to get the total amount sponsored by each of your sponsors?

[cheshire137]

Hi! I'm a dev on the Sponsors team at GitHub. This is a good question, and we don't have the best solution for this right now. You can somewhat assemble this yourself right now with a query like this:

query {
  organization(login:"YourOrgLoginHere") {
    sponsorsActivities(actions:[NEW_SPONSORSHIP, TIER_CHANGE], period:ALL, last:100, includePrivate:true){
      nodes{
        sponsorsTier{
          monthlyPriceInDollars
          isOneTime
        }
        sponsor {
          ... on User {login}
          ... on Organization {login}
        }
      }
    }
  }
}

However, depending on the sponsors you have and their SAML settings, you might get back partial results, with errors like this one for some sponsors:

Although you appear to have the correct authorization credentials, the someSponsoringOrg organization has enabled OAuth App access restrictions, meaning that data access to third-parties is limited. For more information on these restrictions, including how to enable this app, visit https://docs.github.com/articles/restricting-access-to-your-organization-s-data/

I'm going to note this in an issue on our side, because I think we can improve the interface for getting this kind of information. We have a Sponsorable.totalSponsorshipAmountAsSponsorInCents field for getting the lifetime amount that a user/org has given (see https://github.com/orgs/community/discussions/3818#discussioncomment-3494400) but not the amount a user/org has received, broken down by sponsor.

[pomber]

Thanks, my use case is displaying the list of all-time sponsors like this, sorted by amount sponsored

[cheshire137]

Okay, we have a better endpoint for you now! Can you try Sponsorable.lifetimeReceivedSponsorshipValues and see how that works for you? Sample query:

query {
  viewer {
    lifetimeReceivedSponsorshipValues(first: 100) {
      nodes{
        amountInCents
        formattedAmount
        sponsor {
          ... on User { login }
          ... on Organization { login }
        }
      }
    }
  }
}

You can try it via https://docs.github.com/en/graphql/overview/explorer for yourself, there should be enough OAuth scopes there for requesting this on a user. To query it for an organization, you'll need I believe the admin:org scope, which that GraphQL Explorer page doesn't include.

[pomber]

It works! thanks a lot.

I compared it with the exported CSV for Code Hike and everything matches except one org that is missing. The missing org is GitHub so it may be a special edge case.

[cheshire137]

Oh good! Hmm, I wonder if the GitHub org is missing due to extra permissions. I believe orgs can control data access about them from the API, I know I've made queries before around sponsorships where some org sponsors were omitted with an error around that.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬