Sign in
External Services - Query

Get detailed information about an entity (table schema)

get/external-services/{service_id}/query/containers/{path}/entities/{entity}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/external-services/{service_id}/query/containers/{path}/entities/{entity}
  • Auth: HTTP bearer

Path parameters

service_idinteger required
pathstring required
entitystring required

Response

Entity details

container_pathstring[] required

Full container path

entitystring required

Entity name

entity_typestring required

Entity type

metadataunknown
row_countinteger nullable

Approximate row count (for tables/collections)

size_bytesinteger nullable

Size in bytes (for objects/files)

sort_schemaunknown

Example response

{
  "container_path": [
    "mydb",
    "public"
  ],
  "entity": "users",
  "entity_type": "table",
  "fields": [
    {
      "field_type": "Int64",
      "name": "id"
    }
  ],
  "row_count": 1234,
  "size_bytes": 1048576
}

Changes

No recorded changes to this operation across all 50 revisions of this API.