Skip to main content
POST
/
api
/
report
/
getSummaryCountReport
Get summary count report
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getSummaryCountReport \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "interval": "MINUTELY",
  "scope": "REGION",
  "type": "CROWD"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "timeSeriesDataPoints": [
    {
      "avgEventCountMap": {},
      "dateLocal": "<string>",
      "dateUtc": "<string>",
      "maxEventCountMap": {},
      "minEventCountMap": {},
      "reportingDevicesMap": {}
    }
  ],
  "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 summary count reports.

​
interval
enum<string>
required

Report interval for filtering face events

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

Scope of the report to reset

Available options:
REGION,
DEVICE,
LOCATION,
ORG
​
type
enum<string>
required

Type of report to receive

Available options:
CROWD,
PEOPLE,
FACES,
MOTION,
BANDWIDTH,
VEHICLES,
LICENSEPLATES,
ALERTS,
AM_VERIFICATION,
DWELL
​
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"

Response

200 - application/json

OK

Response object for getting summary count reports.

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

List of summary count time series data points

​
warningMsg
string | null