Datahub API Cheat Sheet

# With curl
curl -u "username:password" "https://reachdatahub.org/api/endpoint"

# With wget
wget --user=username --password=password "https://reachdatahub.org/api/endpoint"

Resource  Endpoint  Description
Data Elements  /api/dataElements  Get all data elements
Data Element Groups  /api/dataElementGroups  Group data elements
Indicators  /api/indicators  All indicators
Indicator Groups  /api/indicatorGroups  Group indicators
Data Sets  /api/dataSets  Data collection forms
Programs  /api/programs  Tracker programs
Organisation Units  /api/organisationUnits  Health facilities, districts
Organisation Unit Groups  /api/organisationUnitGroups  Group OUs
Categories  /api/categories  Data element categories
Category Options  /api/categoryOptions  Category options
Category Combos  /api/categoryCombos  Category combinations
Attributes  /api/attributes  Metadata attributes
Option Sets  /api/optionSets  Fixed value lists

?fields=id,name,code - Select specific fields
?filter=name:like:ANC - Filter results
?paging=false - Get all records
?pageSize=50 - Pagination size
?order=name:asc - Sort results

Operation  Endpoint  Method
Submit Data Values  /api/dataValues  POST
Get Data Values  /api/dataValues  GET
Bulk Data Value Import  /api/dataValueSets  POST

curl -u "user:pass" "https://reachdatahub.org/api/dataValueSets?dataSet=pBOMPrpg1QX&period=202401&orgUnit=DiszpKrYNg8"

json
{
  "dataSet": "pBOMPrpg1QX",
  "period": "202401",
  "orgUnit": "DiszpKrYNg8",
  "dataValues": [
    {"dataElement": "FTRrcoaog83", "value": "42"},
    {"dataElement": "Bpx0589u8y0", "value": "37"}
  ]
}

Analysis Type  Endpoint  Description
Aggregate Data  /api/analytics  Aggregate data analysis
Event Data  /api/analytics/events  Event/ tracker analysis
Enrollments  /api/analytics/enrollments  Program enrollments
Resource Table  /api/resourceTables  Rebuild analytics tables

curl -u "user:pass" \

  "https://reachdatahub.org/api/analytics?dimension=dx:fbfJHSPpUQD;cYeuwXTCPkU&dimension=pe:LAST_12_MONTHS&dimension=ou:O6uvpzGd5pu;LEVEL-2&displayProperty=NAME&skipMeta=false"

Resource  Endpoint  Method
Single Event  /api/events/{id}  GET/PUT/DELETE
Multiple Events  /api/events  GET/POST
Event Query  /api/tracker/events  GET

{
  "events": [{
    "program": "eBAyeGv0exc",
    "orgUnit": "DiszpKrYNg8",
    "eventDate": "2024-01-15",
    "status": "COMPLETED",
    "dataValues": [
      {"dataElement": "qrur9Dvnyt5", "value": "Yes"}
    ]
  }]
}

Resource  Endpoint  Method
Single Enrollment  /api/enrollments/{id}  GET/PUT/DELETE
Multiple Enrollments  /api/enrollments  GET/POST
Tracker Query  /api/tracker/enrollments  GET

curl -u "user:pass" \
  "https://reachdatahub.org/api/users?fields=id,displayName,email,userCredentials[username]&paging=false"

Resource  Endpoint  Description
System Info  /api/system/info  Version, build info
Settings  /api/systemSettings  System configuration
Tasks  /api/tasks  Background tasks
Job Configurations  /api/jobConfigurations  Scheduled jobs

Operation  Endpoint  Method
Export Metadata  /api/metadata  GET
Import Metadata  /api/metadata  POST
Gist API  /api/gist  GET
Synchronization  /api/synchronization  GET/POST

Resource  Endpoint  Description
Organisation Unit Geometry  /api/organisationUnits/{id}/geometry  GET/PUT
Maps  /api/maps  Map configurations
GeoJSON  /api/organisationUnits.geojson  Spatial data

# Search by name
?filter=name:like:malaria

# Multiple filters
?filter=name:like:anc&filter=created:ge:2024-01-01

# Field selection (improves performance)
?fields=id,name,code,displayName

# Pagination control
?pageSize=1000&page=1

curl -H "Accept-Encoding: gzip" -H "Content-Type: application/json+gzip" \
  --data-binary @data.gz https://reachdatahub.org/api/dataValueSets

# Check task status
curl -u "user:pass" "https://reachdatahub.org/api/system/tasks/ANALYTICS_TABLE"

# Force analytics table update
curl -u "user:pass" -X POST "https://reachdatahub.org/api/resourceTables/analytics"

1. API Tokens: Consider using API tokens instead of passwords

2. Rate Limiting: Be mindful of API rate limits

3. Bulk Operations: Use `dataValueSets` endpoint for bulk data

4. Field Selection: Always specify `fields` parameter to reduce payload

5. Compression: Enable gzip for large data transfers

6. Error Handling: Check HTTP status codes:
   - `200`: Success
   - `400`: Bad request
   - `401`: Unauthorized
   - `403`: Forbidden
   - `409`: Conflict (duplicate data)
   - `500`: Server error

- DHIS2 API Documentation: `/api/` (browse via web browser)
- Swagger UI: `/api/api-docs` (if enabled)
- DHIS2 Core Documentation: [docs.dhis2.org](https://docs.dhis2.org/)
- API Version: 2.40 supports API versions 38, 39, and 40