Skip to main content
POST
/
api
/
report
/
getCountReport
Get count report
curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getCountReport \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "endDate": "2024-01-31",
  "interval": "MINUTELY",
  "scope": "REGION",
  "startDate": "2024-01-01",
  "type": "CROWD",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "timeSeriesDataPoints": [
    {
      "dateLocal": "<string>",
      "dateUtc": "<string>",
      "eventCountMap": {},
      "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 count reports.

​
endDate
string | null

End date for the report

Example:

"2024-01-31"

​
interval
enum<string>

Report interval for filtering face events

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

Scope of the report to reset

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

Start date for the report

Example:

"2024-01-01"

​
type
enum<string>

Type of report to receive

Available options:
CROWD,
PEOPLE,
FACES,
MOTION,
BANDWIDTH,
VEHICLES,
LICENSEPLATES,
ALERTS,
AM_VERIFICATION,
DWELL
​
uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for getting count reports.

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

List of time series data points for count report

​
warningMsg
string | null