Query Event Guidelines

See How To Use this Guide before interpreting the guidelines below.

The following is the Query Event Request/Response guidelines table:

Data Element Occurs
Length		 Type Description
time [0...1]
[1/*]		 String Use this to query using time parameters.
  past [0...1]
[1/*]		 String Returns all events based upon a number and unit (e.g. minutes, hours, days). *1
    amount [0...1]
[1/*]		 String Required. The amount of time.  *2
    unit [0...1]
[1/*]		 String

Required. The unit of time relating to the amount. Valid values: *3

  • MILLIS
  • SECONDS
  • MINUTES
  • HOURS
  • DAYS
  • WEEKS
  timestamp [0...1]
[1/*]		 String Returns all events based upon a start and end time. *4
    start [0...1]
[1/*]		 String Required. The start time in UTC Event Date Time format. *5
    end [0...1]
[1/*]		 String Required. The end time in UTC Event Date Time format. *6
  date-time [0...1]
[1/*]		 String Returns all events based upon a start and end date. *7
    start [0...1]
[1/*]		 String Required. The start date (e.g. 200307).
    end [0...1]
[1/*]		 String Required. The end date (e.g. 200308).
  since [0...1]
[1/*]		 String Returns all events since the specified timestamp or date. *8
    mode [0...1]
[1/*]		 String

Required. The type of since query. Valid values:

  • date-time
  • timestamp
    timestamp [0...1]
[1/*]		 String Conditionally required if mode equals timestamp. The time in UTC Event Date Time format.
    date-time [0...1]
[1/*]		 String Conditionally required if mode equals timestamp. The date (e.g. 200307).
select [0...1]
[1/*]		 String The set of fields to return in the Query Event Response. *9
  fields [0...1]
[1/*]		 String Required. Grouping for desired fields.
    name [0...1]
[1/*]		 String Required. Valid value: data
    expression [0...1]
[1/*]		 String Required. A list of desired fields to retrieve. This may include any fields that were included in the Set Event Request.
query-filter [0...1]
[1/*]		 String The name/value pairs to be used as search criteria for the Query Event Request. The select search criteria may include any fields that were included in the Set Event Request. *10