Skip to main content
POST
/
api
/
report
/
getRunningAverage
Get running average
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getRunningAverage \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "interval": "MINUTELY",
  "scope": "REGION",
  "endDate": "<string>",
  "endTimeMs": 1,
  "startDate": "<string>",
  "startTimeMs": 1,
  "timeZone": "America/Los_Angeles",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "statsDataPoints": [
    {
      "date": "<string>",
      "stats": {}
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting running average statistics.

​
interval
enum<string> | null
required

Supports HOURLY, DAILY, WEEKLY, and MONTHLY, returns averages for hours of the interval selected

Available options:
MINUTELY,
QUARTERHOURLY,
HOURLY,
DAILY,
WEEKLY,
MONTHLY
​
scope
enum<string> | null
required

Level of granularity to get statistics for

Available options:
REGION,
DEVICE,
LOCATION,
ORG
​
endDate
string | null
deprecated

Deprecated input, use endTimeMs instead

​
endTimeMs
integer<int64> | null

End datetime provided as a UNIX timestamp in milliseconds

Required range: x >= 0
​
startDate
string | null
deprecated

Deprecated input, use startTimeMs instead

​
startTimeMs
integer<int64> | null

Start datetime provided as a UNIX timestamp in milliseconds

Required range: x >= 0
​
timeZone
string | null

String of timezone for bucketing

Example:

"America/Los_Angeles"

​
uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for getting running average statistics.

​
error
boolean | null
​
errorMsg
string | null
​
statsDataPoints
object[] | null

List of weekly statistics data points

​
warningMsg
string | null