search

DPGAlliance / publicgoods-api

API for Digital Public Goods
The Unlicense
14 stars 5 forks source link

Create new endpoint: `GET /{dpgs,nominees}/unicef-venture/` #1

Open jwflory opened 2 years ago

jwflory commented 2 years ago

Summary

Create a new endpoint to get all DPGs or DPG nominees created by a UNICEF Venture Fund company.

Background

The UNICEF Venture Fund website is being reworked. As part of this rework, we want to better show which UNICEF Venture Fund companies have gone on to either become a DPG or a DPG nominee. This would be shown in a company profile with other information about the company and their work.

Currently, there is no automated way to discover whether a DPG or DPG nominee is a Venture Fund company. To get this data, a Venture Fund portfolio manager or mentor must manually crawl through the list and identify Venture Fund companies from the Registry. This is prone to error and some companies may be missed if their product is not tracked by the Venture Fund.

So, there should be an easier way to discover which DPGs and DPG nominees come from UNICEF Venture Fund companies.

Details

I see the following steps as successfully implementing this task:

  1. Create a new boolean data point in organizations object of a DPG or nominee, e.g. organizations.unicef_venture_company as true or false
  2. Add a new question to the DPG Submission Form to inquire whether the company/organization behind the project received funding from the UNICEF Venture Fund
  3. Create new endpoint to list all DPG + Venture Fund companies: GET /dpgs/unicef-venture/
  4. Create new endpoint to list all DPG nominee + Venture Fund companies: GET /nominees/unicef-venture/

Outcome

Easier to discover what DPG and DPG nominees are connected to the UNICEF Venture Fund, and to use this data automatically for the new Fund website to cross-promote our work with DPGs

jwflory commented 2 years ago

Note: Per the issue mentioned above, this data seems to exist in some submissions in organizations.org_type == "funder" && organizations.name == "UNICEF Ventures Fund". This could form the basis of a new API endpoint that returns only Venture Fund companies.

nathanfletcher commented 1 year ago

*To be added as a search term and also created for the new API