Query

About queries

Every GraphQL schema has a root type for both queries and mutations. The Query type defines GraphQL operations that retrieve data from the server. It is the root type for all requests that require an immediate response and do not modify data stored within the Worlds system.

A quick note on pagination: Many queries are paginated to limit the number of results provided to a client to reasonable default volumes. Paging may be controlled by the client via the first and after arguments:

• first is an Int argument that specifies how many results to return in the response. If not provided, a default value may be used.
• after is a String argument that may be provided to contain a “cursor”, such as found on Edge types and the PageInfo type. This prompts the server to return only elements after the given cursor.

When using a cursor, identical arguments (including filters) should be provided to get expected results.

dataSource

Look up a data source’s information by its unique identifier.

Type: DataSource

Arguments for dataSource

Name	Description
id (ID!)	The data source’s unique numeric ID or UUID.

dataSources

Search for data sources based on a set of filters.

Type: DataSourceConnection

Arguments for dataSources

Name	Description
filter (FilterDataSourceInput)	Filter data sources by type and/or position.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([DataSourceSort!]!)	The field and direction by which to sort the results

detections

Finds detections, which are objects detected by the Worlds system, based on a set of filters.

Type: DetectionConnection

Arguments for detections

Name	Description
filter (FilterDetectionInput!)	Filter detections based on the originating device, time period, etc.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([DetectionsSort!]!)	The field and direction by which to sort the results

device

Look up a device’s information by its unique identifier.

Type: Device

Arguments for device

Name	Description
id (ID!)	The sensor’s unique numeric ID or UUID.

devices

Search for devices based on a set of filters.

Type: DeviceConnection

Arguments for devices

Name	Description
filter (FilterDeviceInput)	Filter devices by id, uuid and/or name.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([DevicesSort!]!)	The field and direction by which to sort the results

embeddingForDataSource

Generate an embedding vector of a data source’s asset at a specified timestamp

Type: EmbeddingResponse

Arguments for embeddingForDataSource

Name	Description
dataSourceId (ID!)	The ID of the data source
timestamp (DateTimeOffset!)	The time at which the embedding vector will be generated
options (EmbeddingOptionsInput)	Optional embedding parameters.

embeddingForFrame

Generate an embedding vector of a frame

Type: EmbeddingResponse

Arguments for embeddingForFrame

Name	Description
frameId (ID!)	The ID of the frame
options (EmbeddingOptionsInput)	Optional embedding parameters.

embeddingForImage

Generate an embedding vector of an image

Type: EmbeddingResponse

Arguments for embeddingForImage

Name	Description
imageId (ID!)	The ID of the image
options (EmbeddingOptionsInput)	Optional embedding parameters.

embeddingForTrack

Generate an embedding vector for the detection described by the provided track ID and timestamp.

Type: EmbeddingResponse

Arguments for embeddingForTrack

Name	Description
trackId (ID!)	The ID of the track
timestamp (DateTimeOffset!)	A timestamp within the lifetime of the track. An embedding will be generated for the detection closest to this timestamp for the specified track.
options (EmbeddingOptionsInput)	Optional embedding parameters.

embeddingForUrl

Generate an embedding vector of the image at the specified URL

Type: EmbeddingResponse

Arguments for embeddingForUrl

Name	Description
url (String!)	The URL of the image
options (EmbeddingOptionsInput)	Optional embedding parameters.

embeddingForVideo

Generate an embedding vector of a video at the specified timestamp

Type: EmbeddingResponse

Arguments for embeddingForVideo

Name	Description
videoId (ID!)	The ID of the video
timestamp (DateTimeOffset!)	The time at which the embedding vector will be generated
options (EmbeddingOptionsInput)	Optional embedding parameters.

event

Look up an event by its unique identifier.

Type: Event

Arguments for event

Name	Description
id (ID!)	The event’s unique identifier.

events

Search for events based on a set of filters.

Type: EventConnection

Arguments for events

Name	Description
filter (FilterEventInput!)	Filter events by unique identifier, type, time, etc.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([EventsSort!]!)	The field and direction by which to sort the results

eventsSummary

Summarizes events over a time range.

Type: EventsSummary

Arguments for eventsSummary

Name	Description
startTime (DateTimeOffset!)	Start time for the summary.
endTime (DateTimeOffset!)	End time for the summary.
bucket (SummaryBucketSize)	If provided, return summary buckets of this size.

eventProducer

Look up an event producer by its unique identifier.

Type: EventProducer

Arguments for eventProducer

Name	Description
id (ID!)	The event producer’s unique identifier.

eventProducers

Search for event producers based on a set of filters.

Type: EventProducerConnection

Arguments for eventProducers

Name	Description
filter (FilterEventProducerInput)	Filter event producers by unique identifier or name
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([EventProducersSort!]!)	The field and direction by which to sort the results

geofence

Look up a geofence, a real-world geographic area, by its unique identifier.

Type: Geofence

Arguments for geofence

Name	Description
id (ID!)	The geofence’s unique identifier.

geofences

Search for geofences based on a set of filters.

Type: GeofenceConnection

Arguments for geofences

Name	Description
filter (FilterGeofenceInput)	Filter geofences by unique identifier, name, etc.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([GeofencesSort!]!)	The field and direction by which to sort the results

geofenceEvents

Caution

geofenceEvents is deprecated. Use geofenceIntersections instead.

Find events for a geofence based on a set of filters.

Type: GeofenceEventConnection

Arguments for geofenceEvents

Name	Description
filter (FilterGeofenceEventInput!)	Filter geofence events based on the geofence id, time period, etc.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([GeofenceEventsSort!]!)	The field and direction by which to sort the results

geofenceIntersections

Find events for a geofence based on a set of filters.

Type: GeofenceIntersectionConnection

Arguments for geofenceIntersections

Name	Description
filter (FilterGeofenceIntersectionInput!)	Filter geofence intersections based on the geofence id, time period, etc.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([GeofenceIntersectionsSort!]!)	The field and direction by which to sort the results

imageUrl

Caution

imageUrl is deprecated. Use snapshot instead

Retrieve the URL for a screenshot from the given device at a particular timestamp.

Type: String

Arguments for imageUrl

Name	Description
deviceId (ID!)	The unique identifier of the device from which to capture the image.
timestamp (DateTimeOffset!)	The time at which the given image should have been recorded by the device.

measurements

Finds measurements of a sensor based on a set of filters.

Type: MeasurementConnection

Arguments for measurements

Name	Description
filter (FilterMeasurementInput!)	Filter measurements based on the originating sensor, time period, etc.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([MeasurementsSort!]!)	The field and direction by which to sort the results

pointOfInterest

Look up a point of interest, such as its name, associated site, and devices.

Type: PointOfInterest

Arguments for pointOfInterest

Name	Description
id (ID!)	The point of interest’s unique identifier.

pointsOfInterest

Search for points of interest based on a set of filters.

Type: PointOfInterestConnection

Arguments for pointsOfInterest

Name	Description
filter (FilterPointOfInterestInput)	Filter points of interest by id or name.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([PointOfInterestSort!]!)	The field and direction by which to sort the results

segmentationForDataSource

Segment a data source’s asset at a specified timestamp

Type: SegmentationResponse

Arguments for segmentationForDataSource

Name	Description
dataSourceId (ID!)	The ID of the data source
timestamp (DateTimeOffset!)	The time at which the data source will be segmented
options (SegmentationOptionsInput)	Optional segmentation parameters.

segmentationForFrame

Segment a frame

Type: SegmentationResponse

Arguments for segmentationForFrame

Name	Description
frameId (ID!)	The ID of the frame
options (SegmentationOptionsInput)	Optional segmentation parameters.

segmentationForImage

Segment an image

Type: SegmentationResponse

Arguments for segmentationForImage

Name	Description
imageId (ID!)	The ID of the image
options (SegmentationOptionsInput)	Optional segmentation parameters.

segmentationForTrack

Segment an image within the polygon defined by a track’s detection

Type: SegmentationResponse

Arguments for segmentationForTrack

Name	Description
trackId (ID!)	The ID of the track
timestamp (DateTimeOffset!)	The time of the track’s detection. Will use the nearest detection if there isn’t one at this exact timestamp
options (SegmentationOptionsInput)	Optional segmentation parameters.

segmentationForUrl

Segment the image at the specified URL

Type: SegmentationResponse

Arguments for segmentationForUrl

Name	Description
url (String!)	The URL of the image
options (SegmentationOptionsInput)	Optional segmentation parameters.

segmentationForVideo

Segment a video at the specified timestamp

Type: SegmentationResponse

Arguments for segmentationForVideo

Name	Description
videoId (ID!)	The ID of the video
timestamp (DateTimeOffset!)	The time at which the video will be segmented
options (SegmentationOptionsInput)	Optional segmentation parameters.

sensor

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

Type: Sensor

Arguments for sensor

Name	Description
id (ID!)	The sensor’s unique identifier.

sensors

Find sensors based on a set of filters.

Type: SensorConnection

Arguments for sensors

Name	Description
filter (FilterSensorInput)	Filter sensors based on id, name, type, or position.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([SensorsSort!]!)	The field and direction by which to sort the results

site

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

Type: Site

Arguments for site

Name	Description
id (ID!)	The site’s unique identifier.

sites

Find sites based on a set of filters.

Type: SiteConnection

Arguments for sites

Name	Description
filter (FilterSiteInput)	Filter sites based on id.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([SitesSort!]!)	The field and direction by which to sort the results

snapshot

Retrieve an Image for the given data source at a particular timestamp.

Type: Image

Arguments for snapshot

Name	Description
input (CreateSnapshotInput!)	Arguments for retrieving an image (A Data Source ID and a Timestamp).

tag

Look up a tag’s information by its unique identifier.

Type: Tag

Arguments for tag

Name	Description
id (ID)	The tag’s unique numeric ID.
name (String)	The tag’s name.

tags

Search for tags based on a set of filters.

Type: TagConnection

Arguments for tags

Name	Description
filter (FilterTagInput)	Filter tags by id or name.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([TagsSort!]!)	The field and direction by which to sort the results

textReadingForImage

Read text in an image. The image supplied should be a pre-cropped image containing text.

Type: TextReadingResponse

Arguments for textReadingForImage

Name	Description
imageId (ID!)	The ID of the image

textReadingForUrl

Read text in the image at the specified URL. The URL supplied should be a pre-cropped image containing text.

Type: TextReadingResponse

Arguments for textReadingForUrl

Name	Description
url (String!)	The URL of the image

textRecognitionForDataSource

Detect text in a data source’s asset at a specified timestamp

Type: TextRecognitionResponse

Arguments for textRecognitionForDataSource

Name	Description
dataSourceId (ID!)	The ID of the data source
timestamp (DateTimeOffset!)	The time at which text will be detected
options (TextRecognitionOptionsInput)	Optional text recognition parameters.

textRecognitionForFrame

Detect text in a frame

Type: TextRecognitionResponse

Arguments for textRecognitionForFrame

Name	Description
frameId (ID!)	The ID of the frame
options (TextRecognitionOptionsInput)	Optional text recognition parameters.

textRecognitionForImage

Detect text in an image

Type: TextRecognitionResponse

Arguments for textRecognitionForImage

Name	Description
imageId (ID!)	The ID of the image
options (TextRecognitionOptionsInput)	Optional text recognition parameters.

textRecognitionForTrack

Detect text within the polygon defined by a track’s detection

Type: TextRecognitionResponse

Arguments for textRecognitionForTrack

Name	Description
trackId (ID!)	The ID of the track
timestamp (DateTimeOffset!)	The time of the track’s detection. Will use the nearest detection if there isn’t one at this exact timestamp
options (TextRecognitionOptionsInput)	Optional text recognition parameters.

textRecognitionForUrl

Detect text in the image at the specified URL

Type: TextRecognitionResponse

Arguments for textRecognitionForUrl

Name	Description
url (String!)	The URL of the image
options (TextRecognitionOptionsInput)	Optional text recognition parameters.

textRecognitionForVideo

Detect text in a video at the specified timestamp

Type: TextRecognitionResponse

Arguments for textRecognitionForVideo

Name	Description
videoId (ID!)	The ID of the video
timestamp (DateTimeOffset!)	The time at which text will be detected
options (TextRecognitionOptionsInput)	Optional text recognition parameters.

track

Look up a track, a record of the motion of a detected object, by its unique identifier.

Type: Track

Arguments for track

Name	Description
id (ID!)	The track’s unique identifier.
timestamp (DateTimeOffset)	If provided, locate the track within 24 hours of the given time. Otherwise, the track will only be identified if it is less than 24 hours since it was active.

tracks

Finds tracks, which are records of a detected object over time, based on a set of filters.

Type: TrackConnection

Arguments for tracks

Name	Description
filter (FilterTrackInput!)	Filter tracks based on the originating device, time period, etc.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([TracksSort!]!)	The field and direction by which to sort the results

tracksSummary

Summarizes tracks over a time range.

Type: TracksSummary

Arguments for tracksSummary

Name	Description
startTime (DateTimeOffset!)	Start time for the summary.
endTime (DateTimeOffset!)	End time for the summary.
tags (FilterTagInput)	Filter tracks based on their tags.
bucket (SummaryBucketSize)	If provided, return summary buckets of this size.

video

Look up a video by its unique identifier.

Type: Video

Arguments for video

Name	Description
id (ID!)	The video’s UUID.

videos

Search for videos based on a set of filters.

Type: VideoConnection

Arguments for videos

Name	Description
filter (FilterVideoInput!)	Filter videos by Fields to filter videos
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([VideosSort!]!)	The field and direction by which to sort the results

zone

Look up a zone, a region on a camera, by its unique identifier.

Type: Zone

Arguments for zone

Name	Description
id (ID!)	The zone’s unique identifier.

zoneEvents

Caution

zoneEvents is deprecated. Use zoneIntersections instead.

Find events for a zone based on a set of filters.

Type: ZoneEventConnection

Arguments for zoneEvents

Name	Description
filter (FilterZoneEventInput!)	Filter zone events based on the zone id, time period, etc.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([ZoneEventsSort!]!)	The field and direction by which to sort the results

zoneIntersections

Find intersections for a zone based on a set of filters.

Type: ZoneIntersectionConnection

Arguments for zoneIntersections

Name	Description
filter (FilterZoneIntersectionInput!)	Filter zone intersections based on the zone id, time period, etc.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([ZoneIntersectionsSort!]!)	The field and direction by which to sort the results

zones

Find zones based on a set of filters

Type: ZoneConnection

Arguments for zones

Name	Description
filter (FilterZoneInput)	Filter zones based on the specified filters.
first (Int!)	Returns the first n elements from the list.
after (String)	Returns the elements in the list that come after the specified cursor.
sort ([ZonesSort!]!)	The field and direction by which to sort the results