v1

latestSwagger 2.02026-07-13285166341.1 KB
Reporting

Get a list of subscribed clients

No Documentation Found.

get/api/v2/Reporting/RegisteredClients

Query parameters

UpdateGroupIDstring

Optional but required when including any or all of following parameters: ReportValue, ReportResult, ReportResultIsValid. The Update Group ID. If not provided, all clients will be returned.

ClientIDstring

Optional. Filter where ClientID matches a value. Wildcards are supported (*).

Tagstring

Optional. Filter where Tag matches a value. Wildcards are supported (*).

ReportResultstring

Optional and UpdateGroupID must be included. Filter where ReportResult matches a value. Wildcards are supported (*).

ReportResultIsValidboolean

Optional and UpdateGroupID must be included. When 'true' filters results where ReportResult equals ReportResultExpected. When 'false' filters results where ValueToValidate does not equal ReportResults.

ReportValuestring

Optional and UpdateGroupID must be included. Filter where ReportValue matches a value. Wildcards are supported (*).

LastCheckInBeforestring date-time

Optional. Filter where LastCheckIn occured before the provided date.

LastCheckInAfterstring date-time

Optional. Filter where LastCheckIn occured after the provided date.

OrderBystring

Optional. Specify the order in which results should be returned. Use this format: [FieldName] [ASC|ASCENDING|DESC|DESCENDING],...
If sort direction is not provided for a field, it will be sorted ascending.

limitinteger

Optional. The page limit. The default page limit is 10.

offsetinteger

Optional. The page offset. The default page offset is 0.

Response

OK