Skip to contents

Retrieves Aggregated Enrollment Analytics Data from DHIS2

Source: R/get_enrollment_analytics.R
get_enrollment_analytics.Rd

[Experimental] get_enrollment_analytics() retrieves aggregated, dimensional analytics over Tracker enrollments from DHIS2's analytics/enrollments/query/{program} endpoint — as opposed to get_enrollments(), which returns raw individual enrollment records from the Tracker API. Use this when you want counts/aggregates across dimensions (e.g. enrollments by org unit and period), not the underlying records themselves.

Usage

get_enrollment_analytics(
  program,
  ...,
  return_type = c("uid", "name"),
  page_size = 1000,
  retry = 2,
  verbosity = 0,
  timeout = 60,
  auth = NULL,
  call = caller_env()
)

Arguments

program

A program id. Used as a URL path segment, not a query parameter.

...

One or more analytics_dimension() parameters (e.g. ou/pe dimensions via %.d%/%.f%), and/or other query parameters supported by your DHIS2 instance's Tracker analytics query API.

return_type

Optional. 'uid' (default) or 'name' for the identifier scheme used in the response.

page_size

Number of records to request per page (default 1000).

retry

Number of times to retry the API call in case of failure (defaults to 2).

verbosity

Level of HTTP information to print during the call.

timeout

Maximum number of seconds to wait for the API response.

auth

Optional. The authentication object.

call

The caller environment.

Value

A tibble of aggregated enrollment analytics data, or NULL if none was retrieved.

Details

The response shares the same headers/rows shape as get_analytics(). Pagination is automatic; see get_event_analytics()'s details for a note on this endpoint family's pagination behaviour (a different, silently truncating shape confirmed live against a public DHIS2 demo instance for the events variant, which this function shares the same underlying engine with).

See also

get_enrollments() for raw individual enrollment records, get_event_analytics() for the event equivalent, get_analytics() for aggregate (non-Tracker) analytics.

Examples


# Enrollments for a program, by org unit, over the last 12 months
get_enrollment_analytics(program = 'PREnRHSp3be',
                         ou %.d% 'USER_ORGUNIT',
                         pe %.d% 'LAST_12_MONTHS')
#> # A tibble: 89 × 16
#>    pi          tei     enrollmentdate incidentdate storedby createdbydisplayname
#>    <chr>       <chr>   <chr>          <chr>        <chr>    <chr>               
#>  1 qMBqoFYqgtP OJDIrx… 2026-07-01 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#>  2 vARbqJyjbd7 Ke6bkn… 2026-02-18 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#>  3 rElAXaHNBFK FTivY0… 2026-05-13 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#>  4 YK5uJ00bblf xhO85y… 2026-08-01 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#>  5 ueCmCMd1ExY FunsZZ… 2026-06-09 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#>  6 sZU4wQKwWzt PPMSmx… 2026-04-27 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#>  7 t3rg6r3Xypy KNjN7M… 2026-08-08 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#>  8 sM8ncHUMMgX tOdSh1… 2026-05-10 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#>  9 YxyuyiOGcbd u0lDdU… 2026-05-15 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#> 10 YTTJ9DEjQ0v S1lLAL… 2026-07-30 00… 2026-06-06 … stefano  Perotti, Stefano (s…
#> # ℹ 79 more rows
#> # ℹ 10 more variables: lastupdatedbydisplayname <chr>, lastupdated <chr>,
#> #   geometry <chr>, longitude <dbl>, latitude <dbl>, ouname <chr>,
#> #   ounamehierarchy <chr>, oucode <chr>, programstatus <chr>, ou <chr>