Read Features

Get statistics

Returns statistical information about this space.

get/spaces/{spaceId}/statistics

Path parameters

spaceIdstring required

The unique identifier of the space.

Query parameters

skipCacheboolean

If set to true the response is not returned from cache. Default is false.

context'default' | 'extension' | 'super'

The context where the operation will be performed on a composite space. If not specified, the operation occurs based on the extension rules. For additional information, see Space.extends.

Available context are:

ContextDescription
defaultThe default value if none is given. For composite spaces the operation occurs based on the extension rules. For normal spaces this is the only valid context.
extensionThe operation will be executed only in the extension and no operation will be performed in the extended space.
superOnly applicable for read-operations. The operation will be executed only in the space being extended (super space).

Response

Statistical information about a space.

searchablestring

Specifies the scope of searchability of the properties. One of NONE, PARTIAL, ALL.

Example response

{
  "type": "StatisticsResponse",
  "count": {
    "value": 29208,
    "estimated": true
  },
  "contentUpdatedAt": {
    "value": 1692368695049,
    "estimated": true
  },
  "minVersion": {
    "value": 0,
    "estimated": false
  },
  "maxVersion": {
    "value": 27,
    "estimated": false
  },
  "dataSize": {
    "value": 108364,
    "estimated": true
  },
  "bbox": {
    "value": [
      -10,
      -10,
      10,
      10
    ],
    "estimated": true
  },
  "geometryTypes": {
    "value": [
      "Point"
    ],
    "estimated": true
  },
  "properties": {
    "value": [
      {
        "key": "Route",
        "count": 29208,
        "searchable": true
      },
      {
        "key": "Route Type",
        "count": 29208,
        "searchable": true
      }
    ],
    "estimated": true,
    "searchable": "PARTIAL"
  },
  "etag": "072d3ec0f881b4e7"
}

Changes

Changed in 4 of the 50 revisions of this API.44

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the new optional query request parameter context

      new-optional-request-parameter

    • added the optional property to the response with the status

      response-optional-property-added

    • deleted the query request parameter context

      request-parameter-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog