Get summary count report

Get a summary report for a camera, location, or organization

POST /api/report/getSummaryCountReport

Get summary count report

cURL

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 '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "timeSeriesDataPoints": [
    {
      "avgEventCountMap": {},
      "dateLocal": "<string>",
      "dateUtc": "<string>",
      "maxEventCountMap": {},
      "minEventCountMap": {},
      "reportingDevicesMap": {}
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

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

Show child attributes

warningMsg · string | null