OBJECT

Query

Root Query object of the numina-graph schema! Contains queries to access database model information, as well as analytics queries to provide street-level insights.

link GraphQL Schema definition

  • type Query {
  • # The ID of the object
  • #
  • # Arguments
  • # id: [Not documented]
  • node(id: ID!): Node
  • # Filter Organization objects; if not admin, view only your Organization object
  • #
  • # Arguments
  • # name: Filter for Organization objects where name contains this
  • # alias: Filter for Organization objects where alias equals this
  • # sort: Field and direction to sort by
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • organizations(
  • name: String,
  • alias: String,
  • sort: [OrganizationSortEnum],
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): OrganizationsConnection
  • # The ID of the object
  • #
  • # Arguments
  • # id: [Not documented]
  • organization(id: ID!): Organization
  • # Filter Device objects; if not admin, only Devices belonging to your Organization
  • # will be shown
  • #
  • # Arguments
  • # serialno: Filter for Device objects where serialno equals this
  • # name: Filter for Device objects where name contains this
  • # sort: Field and direction to sort by
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • devices(
  • serialno: String,
  • name: String,
  • sort: [DeviceSortEnum],
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): DevicesConnection
  • # The ID of the object
  • #
  • # Arguments
  • # id: [Not documented]
  • device(id: ID!): Device
  • # The ID of the object
  • #
  • # Arguments
  • # id: [Not documented]
  • user(id: ID!): User
  • # List all User objects, admin only
  • #
  • # Arguments
  • # sort: Field and direction to sort by
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • listUsers(
  • sort: [UserSortEnum],
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): UserConnection
  • # Get BehaviorZone objects associated with Device objects with serialno in
  • # serialnos
  • #
  • # Arguments
  • # serialnos: Device serialno values
  • # sort: Field and direction to sort by
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • behaviorZones(
  • serialnos: [String],
  • sort: [BehaviorZoneSortEnum],
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): BehaviorZonesConnection
  • # Compute object counts for all objects with type in obj_classes detected by the
  • # given Devices over a time range, grouped by interval
  • #
  • # Arguments
  • # serialnos: serialno values of Devices for which to compute
  • # metric
  • # startTime: Start of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # endTime: End of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # interval: Time interval to aggregate objects for metric,
  • # expects a string with an integer followed by an interval abbreviation
  • # (m:minutes, h:hour, d:day, w:week, mo:month,y:year) (e.g. '1h', '30m', '1d')
  • # objClasses: List of Object classes ('car', 'pedestrian', 'bus',
  • # 'truck', 'trash', 'dog')
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • feedCountMetrics(
  • serialnos: [String]!,
  • startTime: DateTime!,
  • endTime: DateTime!,
  • interval: String,
  • objClasses: [String]!,
  • timezone: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): FeedMetricsConnection
  • # Compute object counts for all objects with type in obj_classes that intersect
  • # with the given BehaviorZones over a time range, grouped by interval
  • #
  • # Arguments
  • # zoneIds: rawId values for BehaviorZone regions which objects
  • # intersect with. If multiple provided, objects must intersect with zone1 AND
  • # zone2 AND so on
  • # startTime: Start of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # endTime: End of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # interval: Time interval to aggregate objects for metric,
  • # expects a string with an integer followed by an interval abbreviation
  • # (m:minutes, h:hour, d:day, w:week, mo:month,y:year) (e.g. '1h', '30m', '1d')
  • # objClasses: List of Object classes ('car', 'pedestrian', 'bus',
  • # 'truck', 'trash', 'dog')
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • zoneCountMetrics(
  • zoneIds: [Int]!,
  • startTime: DateTime!,
  • endTime: DateTime!,
  • interval: String,
  • objClasses: [String]!,
  • timezone: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ZoneMetricsConnection
  • # Compute heatmap for all objects with type in obj_classes detected by the given
  • # Device over a time range
  • #
  • # Arguments
  • # serialno: serialno value of Device for which to compute heatmap
  • # startTime: serialno value of Device for which to compute
  • # heatmap
  • # endTime: End of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # objClasses: List of Object classes ('car', 'pedestrian', 'bus',
  • # 'truck', 'trash', 'dog')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • feedHeatmaps(
  • serialno: String!,
  • startTime: DateTime!,
  • endTime: DateTime!,
  • timezone: String,
  • objClasses: [String]!,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): FeedHeatmapsConnection
  • # Compute heatmap for all objects of type obj_class that intersect with the given
  • # BehaviorZones over a time range
  • #
  • # Arguments
  • # zoneIds: rawId values of BehaviorZone objects
  • # startTime: Start of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # endTime: End of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # objClasses: List of Object classes ('car', 'pedestrian', 'bus',
  • # 'truck', 'trash', 'dog')
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • zoneHeatmaps(
  • zoneIds: [Int]!,
  • startTime: DateTime!,
  • endTime: DateTime!,
  • objClasses: [String]!,
  • timezone: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ZoneHeatmapsConnection
  • # Compute max occupancy (instantaneous count) for the given Devices over a time
  • # range, grouped by interval
  • #
  • # Arguments
  • # serialnos: serialno values of Devices for which to compute
  • # metric
  • # startTime: Start of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # endTime: End of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # interval: Time interval to aggregate objects for metric,
  • # expects a string with an integer followed by an interval abbreviation
  • # (m:minutes, h:hour, d:day, w:week, mo:month,y:year) (e.g. '1h', '30m', '1d')
  • # objClasses: List of Object classes ('car', 'pedestrian', 'bus',
  • # 'truck', 'trash', 'dog')
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • maxOccupancy(
  • serialnos: [String]!,
  • startTime: DateTime!,
  • endTime: DateTime!,
  • interval: String,
  • objClasses: [String]!,
  • timezone: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): FeedMetricsConnection
  • # Compute max occupancy (instantaneous count) for the given Behavior Zones over a
  • # time range, grouped by interval. For this query, the rectangular bounds of the
  • # behavior zones are used.
  • #
  • # Arguments
  • # zoneIds: rawId values of BehaviorZone objects
  • # startTime: Start of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # endTime: End of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # interval: Time interval to aggregate objects for metric,
  • # expects a string with an integer followed by an interval abbreviation
  • # (m:minutes, h:hour, d:day, w:week, mo:month,y:year) (e.g. '1h', '30m', '1d')
  • # objClasses: List of Object classes ('car', 'pedestrian', 'bus',
  • # 'truck', 'trash', 'dog')
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • zoneMaxOccupancy(
  • zoneIds: [Int]!,
  • startTime: DateTime!,
  • endTime: DateTime!,
  • interval: String,
  • objClasses: [String]!,
  • timezone: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ZoneMaxOccupancyConnection
  • # Get all sample images for a given Device over a time range
  • #
  • # Arguments
  • # serialno: Device serialno
  • # startDate: Start of time range
  • # endDate: End of time range
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • getSampleImages(
  • serialno: String!,
  • startDate: String!,
  • endDate: String!,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): SampleImagesConnection
  • # Get event counts, based on a stored schedule, across time intervals
  • #
  • # Arguments
  • # startTime: Start of time range
  • # endTime: End of time range
  • # eventName: name of the event
  • # interval: Time interval to aggregate objects for metric,
  • # expects a string with an integer followed by an interval abbreviation
  • # (m:minutes, h:hour, d:day, w:week, mo:month,y:year) (e.g. '1h', '30m', '1d')
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • eventCounts(
  • startTime: DateTime!,
  • endTime: DateTime!,
  • eventName: String!,
  • interval: String,
  • timezone: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): EventCountsConnection
  • # Compute dwell time distributation for all objects with type in obj_classes
  • # detected in the given behavior zones over a time range
  • #
  • # Arguments
  • # zoneIds: rawId values for BehaviorZone regions which objects
  • # intersect with. If multiple provided, objects must intersect with zone1 AND
  • # zone2 AND so on
  • # startTime: Start of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # endTime: End of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # objClasses: List of Object classes ('car', 'pedestrian', 'bus',
  • # 'truck', 'trash', 'dog')
  • # interval: Time interval to aggregate objects for metric,
  • # expects a string with an integer followed by an interval abbreviation
  • # (m:minutes, h:hour, d:day, w:week, mo:month,y:year) (e.g. '1h', '30m', '1d')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • zoneDwellTimeDistribution(
  • zoneIds: [Int]!,
  • startTime: DateTime!,
  • endTime: DateTime!,
  • timezone: String,
  • objClasses: [String]!,
  • interval: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ZoneDwellTimeMetricConnection
  • # Compute dwell time distributation for all objects with type in obj_classes
  • # detected by the given Device over a time range
  • #
  • # Arguments
  • # serialnos: serialno values of Devices for which to compute
  • # metric
  • # startTime: Start of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # endTime: End of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # objClasses: List of Object classes ('car', 'pedestrian', 'bus',
  • # 'truck', 'trash', 'dog')
  • # interval: Time interval to aggregate objects for metric,
  • # expects a string with an integer followed by an interval abbreviation
  • # (m:minutes, h:hour, d:day, w:week, mo:month,y:year) (e.g. '1h', '30m', '1d')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • feedDwellTimeDistribution(
  • serialnos: [String]!,
  • startTime: DateTime!,
  • endTime: DateTime!,
  • timezone: String,
  • objClasses: [String]!,
  • interval: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): FeedDwellTimeMetricConnection
  • # Compute max occupancy (instantaneous count) for the given Device over a recent
  • # time range (up to 9 hours old), grouped by interval. If an older time period is
  • # request, an error will be returned.
  • #
  • # Arguments
  • # serialno: serialno values of Devices for which to compute
  • # metric
  • # startTime: Start of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # endTime: End of analysis time range in ISO format (e.g
  • # '2019-01-01T00:00:00)
  • # interval: Time interval to aggregate objects for metric,
  • # expects a string with an integer followed by an interval abbreviation
  • # (m:minutes, h:hour, d:day, w:week, mo:month,y:year) (e.g. '1h', '30m', '1d')
  • # objClass: List of Object classes ('car', 'pedestrian', 'bus',
  • # 'truck', 'trash', 'dog')
  • # timezone: Timezone in tz format to localize time range and
  • # intervals (e.g. 'America/New_York')
  • # before: paginate results before cursor
  • # after: paginate results after cursor
  • # first: get first n results
  • # last: get last n results
  • recentMaxOccupancy(
  • serialno: String!,
  • startTime: DateTime!,
  • endTime: DateTime!,
  • interval: String,
  • objClass: String!,
  • timezone: String,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): FeedMetricsConnection
  • }

link Require by

This element is not required by anyone