HPC Planning Bridge Tool API

The HPC Planning Bridge Tool API is an analytical tool designed to leverage HPC data and can be customized to suit various contexts. This new HPC "bridge tool" is designed to support OCHA and cluster coordinators by bridging the RPM and Projects Module. It enables cluster coordinators to guide project development and prioritize activities by geographical area and target population.

Traditionally, coordinators plan activities based on HNO data, setting targets by area and population, and uploading them to RPM. However, they couldn’t track if project drafts met these targets accurately. For example, in food security, the coordinator might set a 1 million target, but couldn’t monitor if partner projects collectively reached or overshot this.

The planning bridge tool now provides a dashboard view, allowing coordinators to adjust projects proactively, balancing surpluses and deficits before finalization. It’s also helpful for countries using activity-based planning, showing funded and implemented project totals by area and activity.

The endpoint includes for each plan the following datasets:

• organizations: Includes the organizations involved with the plan. Organizations can be the partners submitting projects, partners receiving funds and donors sending funds.

• locations: Includes all updates CODs at all Admin levels of the plan.

• projects: All projects that have been submitted against the plan, including project ID, code and name, status, clusters, organizations, and all condition field values. Condition fields are custom questions answered for each projects such as Gender mainstreaming, CASH ..etc.

• planClusters: Includes all field clusters activated which have caseloads and financial requirements.

• planGlobalClusters: Global clusters associated with plan clusters which have caseloads and financial requirements.

• planEntities: Includes both plan and cluster level objectives and activities such as Strategic Objectives, Cluster Objectives and Cluster Activities. This field also includes information about the alignment upper level entities

• caseloads are metrics relating to populations, such as:

  • Total population
  • People affected
  • People in need
  • People targeted by plan

This field contains such information as description and cluster target as well as the target for each project submitted against this cluster

• indicators are more general, and can be used to track progress. Data captured for indicators are the indicators descriptions, metrics such as Indicator target and the project targets. Disaggregated data for the indicators can also be obtained when the proper options are set true as describe below.

• fundingData: broken down by plan cluster, global cluster, and by donor, receiving organization and receiving project.

• conditionFields: contains information such as name and question type about the custom questions to be responded by project owner during project submissions.

Getting Started using the HPC Planning Bridge Tool API

The bridge tool can be used in a number of different ways:

• Using the API Directly
• Using the Excel Workbook
• Using our Dashboard Tool. Watch a video illustrating using the Bridge Tool in Nigeria context

Usage of the API and Excel Workbook are detailed in this document, but if you would like to use the dashboard, please contact api-support@hpc.tools and we can help you set this tool up for you.

Using the API Directly

Request

API requests should be GET requests to the following URL.

https://api.hpc.tools/v2/planningBridgeTool

With the following query parameters:

Parameter	Required / Default Value	Details
planId	Required	The numeric ID of the plan you wish to get data for.
includeDisaggregatedData	Optional (default: false)	Set to true if disaggregated data should be included
disaggregationOnlyTotal	Optional (default: false)	Set to true if the totals by location should be included. This option is to set the mode of disaggregation and only meaningful when includeDisaggregatedData is set true
includeBudgetBreakdowns	Optional (default: false)	Set to true if per-project budget breakdowns should be included
includeConditionFields	Optional (default: false)	Set to true if condition fields answers should be included
includeFundingData	Optional (default: false)	Set to true if funding data should be included
includeProjectsComments	Optional (default: false)	Set to true if project comments should be included

For example, requests could look like the following:

• GET https://api.hpc.tools//v2/planningBridgeTool?planId=1172
  

• GET https://api.hpc.tools//v2/planningBridgeTool?planId=1172&includeDisaggregatedData=True&disaggregationOnlyTotal=true&includeBudgetBreakdowns=True&includeConditionFields=True
  

Response

Responses will look something like this, the exact shape of the data will depend on which parameters you have set to true above.

{
    "data": {
        "organizations": [
            {
                "id": 3468,
                "name": "SOS Children's Villages",
                "abbreviation": "SOS",
                "orgType": "NGOs",
                "orgSubtype": "International NGOs",
                "url": "https://www.internationalsos.com/"
            },
            {
                "id": 13795,
                "name": "Instituto Salvadoreño del Migrante",
                "abbreviation": "INSAMI",
                "orgType": "NGOs",
                "orgSubtype": "National NGOs/CSOs",
                "url": "https://insami.foundation/"
            },
            {
                "id": 4293,
                "name": "United Nations Population Fund",
                "abbreviation": "UNFPA",
                "orgType": "Multilateral Organizations",
                "orgSubtype": "UN Agencies",
                "url": "https://www.unfpa.org"
            }
        ],
        "locations": [
            {
                "id": 67,
                "pcode": "SV",
                "name": "El Salvador",
                "adminLevel": 0,
                "latitude": 13.72764124904,
                "longitude": -88.863153241768,
                "parentLocationId": null
            },
            {
                "id": 25921725,
                "pcode": "SV1423",
                "name": "Usulután",
                "adminLevel": 2,
                "latitude": 13.2736585,
                "longitude": -88.42972482,
                "parentLocationId": 25921461
            }
        ],
        "projects": [
            {
                "projectId": 208625,
                "projectName": "Fortaleciendo la Coordinación Humanitaria en El Salvador",
                "projectCode": "HSLV24-CSS-208625-1",
                "projectStatus": "accepted",
                "projectBudgetUSD": 339396,
                "projectOrganizations": [
                    4396
                ],
                "planClusters": [
                    {
                        "clusterId": 7553,
                        "clusterStatus": "accepted"
                    }
                ]
            },
            {
                "projectId": 208926,
                "projectName": "Mejorados los mecanismos para la protección integral de niñas, niños y adolescentes en contextos de movilidad humana en El Salvador.",
                "projectCode": "HSLV24-PRO-208926-1",
                "projectStatus": "accepted",
                "projectBudgetUSD": 200000,
                "projectOrganizations": [
                    9414
                ],
                "planClusters": [
                    {
                        "clusterId": 7547,
                        "clusterStatus": "accepted"
                    }
                ]
            },
            {
                "projectId": 212587,
                "projectName": "Anticipatory actions to save lives and agricultural livelihoods affected by El Niño 2023-2024 phenomenon in El Salvador",
                "projectCode": "HSLV24-FSC-212587-1",
                "projectStatus": "accepted",
                "projectBudgetUSD": 10700000,
                "projectOrganizations": [
                    4399
                ],
                "planClusters": [
                    {
                        "clusterId": 7313,
                        "clusterStatus": "accepted"
                    }
                ]
            }
        ],
        "planClusters": [
            {
                "clusterId": 7549,
                "clusterName": "Alojamiento de Emergencias",
                "clusterCustomRef": "CLSHL"
            },
            {
                "clusterId": 7552,
                "clusterName": "Coordinación y Gestión de Albergues Temporales (CCCM)",
                "clusterCustomRef": "CLCCM"
            }
        ],
        "planGlobalClusters": [
            {
                "planClusters": [
                    7547
                ],
                "globalClusterId": 13,
                "globalClusterCode": "PRO-GBV",
                "globalClusterName": "Protection - Gender-Based Violence",
                "globalClusterType": "aor"
            },
            {
                "planClusters": [
                    7547
                ],
                "globalClusterId": 12,
                "globalClusterCode": "PRO-CPN",
                "globalClusterName": "Protection - Child Protection",
                "globalClusterType": "aor"
            },

        ],
        "planEntities": [
            {
                "entityId": 25902,
                "type": "CO",
                "entityRef": "CLHEA/CO1",
                "entityDescription": "Contribuir a  la capacidad de atención básica y asistencia humanitaria en salud de las personas afectadas y en riesgo con necesidades ocasionadas por emergencias humanitarias, particularmente por el fenómeno del niño y movilidad humana.",
                "planCluster": 7550,
                "supports": [
                    25846,
                    25847
                ]
            },
            {
                "entityId": 25907,
                "type": "CO",
                "entityRef": "CLPRO/COVBG1",
                "entityDescription": "Mejorar el acceso a servicios de calidad, seguros, oportunos, confidenciales y coordinados, a las mujeres y las niñas (incluidas las que tienen discapacidades, adultas mayores, indígenas, población LGBTIQ+ y en movilidad humana)  víctimas y/o en riesgo de VBG, desde un enfoque centrado en las personas sobrevivientes",
                "planCluster": 7547,
                "supports": [
                    25846
                ]
            }

        ],
        "caseloads": [
            {
                "caseloadId": 45898,
                "caseloadCustomRef": "CLSHL/BF1-SHL",
                "caseloadType": "caseLoad",
                "caseloadDescription": "Albergue y artículos no alimentarios",
                "clusterId": 7549,
                "clusterTarget": 6200,
                "projectTargets": [
                    {
                        "projectId": 209093,
                        "projectTarget": 500
                    },
                    {
                        "projectId": 209104,
                        "projectTarget": 700
                    },
                    {
                        "projectId": 208803,
                        "projectTarget": 2000
                    },
                    {
                        "projectId": 208921,
                        "projectTarget": 3000
                    }
                ],
                "projectTargetsByStatus": {
                    "accepted": {
                        "targetSum": 6200,
                        "projectCount": 4
                    }
                }
            },
            {
                "caseloadId": 45893,
                "caseloadCustomRef": "CLPRO/BF4-PRO-GBV",
                "caseloadType": "caseLoad",
                "caseloadDescription": "Violencia de género (VDG)",
                "clusterId": 7547,
                "clusterTarget": 115000,
                "projectTargets": [
                    {
                        "projectId": 209029,
                        "projectTarget": 0
                    },
                    {
                        "projectId": 209032,
                        "projectTarget": 0
                    },
                    {
                        "projectId": 209039,
                        "projectTarget": 0
                    }
                ],
                "projectTargetsByStatus": {
                    "accepted": {
                        "targetSum": 115000,
                        "projectCount": 32
                    }
                }
            }
        ],
        "indicators": [
            {
                "indicatorId": 47521,
                "clusterId": 7552,
                "planEntityId": 26034,
                "indicatorCustomRef": "CLCCM/CO1/IN1",
                "indicatorDescription": "Número de procesos de coordinación realizados para facilitar la entrega de artículos no alimentarios en albergues temporales, centros de recepción, centros de tránsito y comunidades afectadas acorde a las necesidades de las personas afectadas.",
                "unit": "Activities",
                "calculationMethod": null,
                "clusterTarget": 40,
                "projectTargets": [
                    {
                        "projectId": 209045,
                        "projectTarget": 30
                    }
                ],
                "projectTargetsByStatus": {
                    "accepted": {
                        "targetSum": 30,
                        "projectCount": 1
                    }
                }
            },
            {
                "indicatorId": 47522,
                "clusterId": 7552,
                "planEntityId": 26034,
                "indicatorCustomRef": "CLCCM/CO1/IN2",
                "indicatorDescription": "úmero de personas que perciben una mejora en la atención de sus necesidades básicas. (50% con base a la población atendida)",
                "unit": "People",
                "calculationMethod": null,
                "clusterTarget": 7085,
                "projectTargets": [
                    {
                        "projectId": 209419,
                        "projectTarget": 4000
                    },
                    {
                        "projectId": 209227,
                        "projectTarget": 1600
                    },
                    {
                        "projectId": 209045,
                        "projectTarget": 4606
                    }
                ],
                "projectTargetsByStatus": {
                    "accepted": {
                        "targetSum": 10206,
                        "projectCount": 3
                    }
                }
            }
        ],
        "meta": {
            "language": "en"
        }
    },
    "status": "ok"
}