API docs by Redocly

Digital Twin Registry Statistic API (v2)

Download OpenAPI specification:Download

The Single Point of statistic Information about the existence of Digital Twins and their Aspects, Groups etc.

Authentication

The API offers currently one form of authentication:

  • OAuth2 - An open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications.

Tenant Statistics

Tenant Statistic API provides methods to request statistics over the tenant.

Statistics for the tenant

Returns the statistics information for the tenant

Authorizations:
registry
path Parameters
tenantId
required
string <uuid>

Unique identifier of the owning tenant.

Responses

Response samples

Content type
application/json
{
  • "twinCount": 50,
  • "groupCount": 50,
  • "aspectCount": 50,
  • "aspectTemplateCount": 50,
  • "httpEndpointCount": 50,
  • "mqttEndpointCount": 50,
  • "shellCount": 50,
  • "timestamp": "2021-01-01T00:00:00.000Z"
}

Group Statistics

Group Statistic API provides methods to request statistics over groups.

Lists of all group statistics with cursor pagination

If no query string is given, retrieve all group statistics for the tenant. If a query string is given, this is a RQL query on group statistic properties. By default the page size is limited to 50 items. The maximum page size is limited to 500 items.

Example RQL queries:

filter=in(id, 1, 2, 3)

More information about RQL usage in Digital Twin Registry can be found in the Documentation.

Authorizations:
registry
path Parameters
tenantId
required
string <uuid>

Unique identifier of the owning tenant.

query Parameters
select
string

Define an RQL select option, read more

filter
string

Define an RQL filter query, read more

option
string

Define an RQL sort option, read more

cursor
string

set cursor to nextCursor returned by the previous call to list items in the next page..

limit
integer <int32> [ 0 .. 500 ]
Default: 500

the size of the requested page. Defaults to 500 if omitted. Maximum allowed value is 500.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": "string",
  • "itemCount": 0
}