APIs & services / Reporting datasets (rtld)

VO-wise analytics rows.

Endpointtoday's app

Call: GET /rtld/api/dataset/v1/execute?name=PlusOneCadreAnalyticsVOWise
Service: Reporting datasets (rtld)
Features: Analytics dashboard
When: Periodic 12 h and on demand
Auth: X-SESSIONID set by CoreAPI (dooNowOrThrow)
In the App Service: GET /analytics/dashboard

Use case

Farmer-id drill-down lists for a cadre's VO-filtered dashboard. FetchAnalyticsDataWorker calls it after the VO-wise totals and nine-principles calls, and stores the result in KEY_ANALYTICS_IE_IDS_DATA (getFarmerIeIdsForVos). A failure stores an empty list, so drill-downs open nothing.

Headers

Header	Value	Notes
`X-SESSIONID`	<session token>	Passed explicitly as @Header from AndroidSessionManager.sessionId. AuthInterceptor still retries once with a fresh token on 401 or 400.

Parameters

Param	In	Required	Example	Notes
`name`	query	Yes	`PlusOneCadreAnalyticsVOWise`	Dataset name. The rtld executor (/rtld/api/dataset/v1/execute) picks the dataset by this query param.
`version`	query	Yes	`1`	Dataset version. Always 1.
`format`	query	Yes	`json`	Response format. Always json, so the body is a JSON array of row objects.
`params`	query	Yes	`IN_PARAM_VO_CODE=VO-ALIAS-001`	Dataset input parameters as KEY=value pairs joined with "--". IN_PARAM_VO_CODE = comma-separated VO aliases selected in the dashboard filter.

Request

No body. VO params

Response

Example response body (synthetic data)

[
  {
    "CadreLogin": "9XXXXXXXX1",
    "VOCode": "VO-ALIAS-001",
    "c1DailyFarmersIeIds": "100001",
    "c1MonthlyFarmersIeIds": "100001,100002",
    "c1overallFarmersIeIds": "100001,100002,100005",
    "s2soverallFarmersIeIds": "100003",
    "pmdsoverallFarmersIeIds": "100006",
    "s2swoverallFarmersIeIds": "",
    "rdsoverallFarmersIeIds": "",
    "dkg365overallFarmersIeIds": "100002"
  }
]

Field	Type	Notes
`VOCode`	string	VO the row belongs to.
`{model}{Daily,Monthly,overall}FarmersIeIds`	string (CSV)	Farmer ids behind each figure for drill-down.
`Count fields`	number	MisDataDtoItem counts, if returned; parsed but the stored list is used for ids.

Errors

Status	When	What the app does
`401 / 400`	Session token expired or rejected	AuthInterceptor refreshes the token and retries once; if the retry also fails, Empty list stored.
`5xx`	Dataset query failed on the server	Empty list stored.
`network error`	No connectivity or timeout	Empty list stored.

Source

app/src/main/java/org/platformcommons/urvi/datasource/network/retrofit/APIInterface.kt
app/src/main/java/org/platformcommons/urvi/datasource/service/FetchAnalyticsDataWorker.kt
app/src/main/java/org/platformcommons/urvi/datasource/network/responsedto/MisDataDtoItem.kt