Skip to main content
POST
/
api
/
export
/
countReports
Download count report
curl --request POST \
  --url https://api2.rhombussystems.com/api/export/countReports \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "endTimeMs": 1721416242907,
  "interval": "MINUTELY",
  "scope": "REGION",
  "startTimeMs": 1719861042000,
  "type": "CROWD",
  "endDate": "2024-07-17T00:00:00Z",
  "startDate": "2024-07-17T00:00:00Z",
  "timeZone": "America/Los_Angeles",
  "uuidList": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ]
}
'
{}

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 exporting count reports with configurable intervals, scopes, and time ranges.

​
endTimeMs
integer<int64> | null
required

End datetime as a UNIX timestamp in milliseconds

Required range: x >= 0
Example:

1721416242907

​
interval
enum<string> | null
required

The chosen interval time of reports

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

The chosen scope of report by Device, Organization, Region or Location

Available options:
REGION,
DEVICE,
LOCATION,
ORG
​
startTimeMs
integer<int64> | null
required

Start datetime as a UNIX timestamp in milliseconds

Required range: x >= 0
Example:

1719861042000

​
type
enum<string> | null
required

Type of alert to fetch

Available options:
CROWD,
PEOPLE,
FACES,
MOTION,
BANDWIDTH,
VEHICLES,
LICENSEPLATES,
ALERTS,
AM_VERIFICATION,
DWELL
​
endDate
string | null
deprecated

Enter the ending date in in ISO 8601 format

Example:

"2024-07-17T00:00:00Z"

​
startDate
string | null
deprecated

Enter the starting date in ISO 8601 format

Example:

"2024-07-17T00:00:00Z"

​
timeZone
string | null

String of timezone for bucketing

Example:

"America/Los_Angeles"

​
uuidList
(string<DeviceFacetUuid> | null)[] | null

Enter the UUID of device(s) or location(s)

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

Response

200 - text/csv; charset=UTF-8
object | null

OK

The response is of type object.