Skip to main content

siteSummary

Query

What a site holds, counted by Core from the search index - places, things, points and collections by type, work orders and service requests, geometry and 3D models, and a line per floor. Use it to judge a site without reading it. Null means Core did not or could not count a section (a token that cannot read things gets things null); zero means it counted and found none.

siteSummary(siteId: String!, topTypes: Int = 25): SiteSummary

Arguments​

ArgumentTypeDefaultDescription
siteIdString!The id of the site to summarise.
topTypesInt25How many types to list per section, largest first. distinctTypes still reports the true number of types. Defaults to 25.

Returns​

SiteSummary: What a site holds, counted by Core from the search index so a client can judge a site without reading it.

Example​

Request
query SiteSummary($siteId: String!) {
  siteSummary(siteId: $siteId) {
    computedAt
    name
    siteId
  }
}