KPI summary

post

https://api.geoconcept.com/delivery/api/nd/missions/kpiSummary

Returns a single driver-level KPI aggregated by users over a period. In this version only aggregationMode=USERS and granularity=TOTAL are supported.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request for the KPI summary endpoint: a single KPI aggregated by users, agency or subcontractor over a given period.

agenciesIds

array of strings

Restrict aggregation to these agency ids.

agenciesIds

aggregationMode

string

enum

Defaults to USERS

Entity dimension the KPI values are aggregated by.

Allowed:

endDate

date-time

Custom period end (exclusive), used when periodType is CUSTOM.

granularity

string

enum

Defaults to TOTAL

Time granularity of the returned KPI values.

Allowed:

kpiType

string

enum

KPI to summarize. Only a subset of KpiList values is supported by this endpoint; unsupported values are rejected.

periodType

string

enum

Defaults to CUSTOM

Period selector. Use CUSTOM together with startDate/endDate for an explicit range.

startDate

date-time

Custom period start (inclusive), used when periodType is CUSTOM.

subContractorIds

array of strings

Restrict aggregation to these subcontractor ids.

subContractorIds

userIds

array of strings

Restrict aggregation to these user logins.

userIds

Headers

UseHTTPCodeOnError

boolean

Defaults to false

Response

defaultAggregated KPI rows.