Monthly KPI | Webcockpit Knowledge Base

Endpoint URL

GET

/api/Sales/getMonthlyKpi

Authentication

This endpoint requires the X-Api-Key header for authentication. Example: X-Api-Key 12345abcdef

Parameters

Name	Type	Position	Description
`storeNumber`	integer (int32)	query	Restaurant number
`countryCode`	string	query	ISO Country code
`month`	string	query	Month value with the “yyyy-MM” format
`totalViewUniqueIdentifier`	string	query	Total view layout unique identifier
`localization`	string	query	Optional: The KPI items localization language. If none is specified then the english language is the default

Responses

200 — OK

Media type: application/json

{
  "success": true,
  "message": "string",
  "warnings": [
    {
      "title": "string",
      "body": "string"
    }
  ],
  "totalViewLayoutGroups": [
    {
      "localizedName": "string",
      "items": [
        {
          "localizedName": "string",
          "unit": "string",
          "value": 0.0,
          "uniqueIdentifier": "string"
        }
      ]
    }
  ],
  "period": {
    "start": "string",
    "end": "string",
    "startDate": "string",
    "endDate": "string"
  },
  "comparisonPeriod": {
    "start": "string",
    "end": "string",
    "startDate": "string",
    "endDate": "string"
  }
}