Do Gooder API wrapper package for R.
NOTE: When reading below, DG_SUBDOMAIN is "organisation" if your portal is located at:
https://organisation.good.do/developer/
This package is a WIP wrapper for the API functionality at the developer portal:
https://[DG_SUBDOMAIN].good.do/developer/
Set environmental variables...
DG_SUBDOMAIN="organisation"
DG_TOKEN="Token cousbRNzkLd8JkiDbh8d0ta99KIkli928yVpnXub"You should be able to find your API token on your developer portal, see the link in the package description.
The package currently provides two higher level functions to interface with Do Gooder.
dg_campaigns()
Returns a tibble of your account's Do Gooder campaigns. Includes campaign name, ID, description, country (eg. AU), country_display (eg. Australia), state (eg. A). state_display (eg. Active), result (eg. U), result_display (eg. Undetermined). campaign_url, external_url, campaign_tag, featured_action, actions.
dg_actions()
Returns a tibble of actions matching your request arguments. Do Gooder's API paginates responses - in order to recursively request all possible actions, use process_pagination = TRUE. Use page_size to set the maximum number of records to return in each request.
Returned tibble will include id, email address, subscribed_to_campaign, test, created, promotion_name, subscribed_to_organisation, and three nested data.tables (API returns these as nested JSON). Nested data.tables are campaign, action, form_data.
If these aren't meeting your needs, the following lower level functions may help...
dg_api()
Make a request to the Do Gooder API, using env variables configured, specify an out_class which will be used to identify an appropriate parse_response to format the returned json into a list.