Skip to content
Worlds API Docs

site

Query

Look up a site’s information, such as its name, location and devices, by its unique identifier.

Response

Returns Site

Arguments

NameTypeDescription
idID!

The site’s unique identifier.

Example

query site(
  $id: ID!
) {
  site(
    id: $id
  ) {
    id
    name
    timezone
    position {
      type
      coordinates
      crs {
        type
        properties
      }
    }
    polygon {
      type
      coordinates
      crs {
        type
        properties
      }
    }
    devices {
      id
      uuid
      externalId
      name
      enabled
      address
      frameRate
      position {
        type
        coordinates
      }
      dataSource {
        id
        name
        type
        labels
      }
      site {
        id
        name
        timezone
      }
      transcoderId
      calibrations {
        id
        timestamp
        precomputeAt
      }
      pointOfInterest {
        id
        name
        metadata
      }
      lastHeartbeat
    }
    pointsOfInterest {
      id
      site {
        id
        name
        timezone
      }
      name
      position {
        type
        coordinates
      }
      devices {
        id
        uuid
        externalId
        name
        enabled
        address
        frameRate
        transcoderId
        lastHeartbeat
      }
      geofences {
        id
        name
        labels
        active
      }
      metadata
    }
    geofences {
      id
      name
      labels
      site {
        id
        name
        timezone
      }
      pointOfInterest {
        id
        name
        metadata
      }
      bounds {
        height
      }
      active
    }
    facilities {
      id
      name
      site {
        id
        name
        timezone
      }
      layers {
        id
        name
        imageUrl
        metadata
      }
      metadata
    }
  }
}