platform-documentation icon indicating copy to clipboard operation
platform-documentation copied to clipboard

API docs use terms that are undefined and unclear.

Open michaelnugent opened this issue 6 years ago • 3 comments

Question: I am looking to get a full list of people giving money to a Patreon account owner from the API, preferable with one of the official libraries. The docs talk about "user", "campaign" and "pledge" as well as "patron" and "creator". The python API (to choose the first one I looked at) has functions to fetch "user", "campaign", "campaign and patrons" and "page of pledges".

It seems like the "creator" is the Patreon account owner and the "patron" are people who are currently subscribed to that creator. But then what is a "user"? What exactly is a campaign? Why do I need one? Why are patrons assigned to campaigns and not creators? Do I need to iterate over campaigns and then for each campaign look at all the patrons? What is a pledge? Is that a single transaction or a synonym for a person somehow?

Can you please define these terms or point me at the doc I missed?

  • Creator:
  • Patron:
  • Campaign:
  • User:
  • Pledge:

Thanks!

michaelnugent avatar May 30 '18 19:05 michaelnugent