This GET operation returns the details of specific KPI data based on the XRefCode that you enter.
Role feature access: HCM Anywhere > Web Services > Patch/Post/Delete KPI Data
The operation uses the following base URL:
https://www.dayforcehcm.com/api/CompanyName/V1/KpiData
Parameters
| Parameter | Description |
|---|---|
| orgUnitXRefCode | The cross-reference codes of the organizational units to retrieve. |
| kpiXRefCode | The cross-reference codes of the KPIs to retrieve. |
| kpiDataType | The type of KPI data to retrieve. Supported values are Actual, Forecast, Plan, and Supplementary. |
| timePeriod | The data time period. Supported values are minute, day, and week. |
| filterFrom | The filter range's start date. |
| filterTo | The filter range's end date. |
| axisXRefCode | (Optional) Filter by axis XRefCode. |
| mdseXRefCode | (Optional) Filter by MDSE XRefCode. |
| isValidateOnly (boolean) |
Used to specify that all of the validations need to be performed without committing any changes. This parameter controls whether committing information to your instance of Dayforce is your responsibility. The URL syntax is: https://www.dayforcehcm.com/api/CompanyName/V1/KpiData?isValidateOnly=true |
Response
The response from this request will contain data from the referenced XRefCode. Here is an example response:
{
"Data": [
{
"OrgUnitXRefCode": "string",
"KpiXRefCode": "string",
"Day": "2023-12-11T18:45:35.716Z",
"Week": "2023-12-11T18:45:35.716Z",
"Minute": "2023-12-11T18:45:35.716Z",
"AggregateToDay": true,
"Value": 0,
"AdjustedValue": 0,
"Forma": "string",
"Forecast": "string",
"AxisXRefCode": "string",
"MdseXRefCode": "string"
}
],
"ProcessResults": [
{
"Code": "string",
"Context": "string",
"Level": "string",
"Message": "string"
}
]
}
The KpiData RESTful API uses the HTTP verbs POST and PATCH to insert new KPI data and update existing data. The consuming application can also query Dayforce to retrieve details about KPI data. You do this by entering specific XRefCodes for KPI data using the Get KpiData request.
You can also add and update KPI data using the POST and PATCH verbs.