Integrations Webservice
Report Webservice

Get Envoy visitors

Get a list of visitors from Envoy to populate reporting logs

post/api/report/getEnvoyVisitors

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/report/getEnvoyVisitors
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

endTimestampMsinteger nullable
includeSignedOutVisitorsboolean nullable
locationIdsstring[] nullable
startTimestampMsinteger nullable

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.