Within the custom SQL editor in Formant Analytics, you can view and query event data in your organization. You can use the table viewer to query events by type, device ID, time of occurrence, and more.

Viewing available parameters to query in the custom SQL editor.

Event types and standard parameters

You can query the following event types:

Formant event type	Table name
Datapoint ingestion	`query_datapoint_event`
Intervention request	`query_intervention_request`
Intervention response	`query_intervention_response`
Start of teleoperation session	`query_teleop_session_record`
Start of port forwarding session	`query_port_forwarding_session_record`
Command sent from Formant to device	`query_command_request`
Command response sent from device to Formant	`query_command_response`
Command from Formant received by device	`query_command_delivery`
Custom event	`query_custom_event`
Comment	`query_comment`
Built-in Formant system	`query_system_event`
Annotation	`query_annotation`
Task summary	`query_task_summary`

All event tables contain the following columns:

Parameter	Description
`id`	ID of this individual event.
`organization_id`	ID of the organization in which this event occurred.
`time`	Time that the event occurred. Note: If the event has an end time and/or duration, this will be available in the additional parameters for that event (see below).
`viewed`	Whether this event has been viewed in the Formant web application.
`device_id`	ID of the device associated with this event.
`tags`	Tags associated with this event.

Additional parameters by event type

In addition to the standard parameters available above, each event type has additional parameters:

Datapoints and triggered events

`query_datapoint_event`

Parameter	Description
`type`	This will likely be `datapoint-event` or `triggered-event`.
`message`	Only used for custom events. Name of the custom event.
`stream_name`	Stream which triggered this event.
`stream_type`	Datatype of the stream which triggered this event.
`severity`	Severity of the event (`info`, `warning`, `critical`, `error`).
`notification_enabled`	Whether this event will generate notifications in the Formant web application.
`end_time`	Timestamp of the end of this event (if applicable).
`duration_ms`	Duration in ms from the `time` parameter to the `end_time` parameter.

Intervention requests

`query_intervention_request`

Parameter	Description
`message`	Only used for custom events.
`intervention_type`	Either `selection` or `labeling`.
`data`	Prompt to be shown to the user to resolve the intervention. For more information, see POST Intervention Request.

`query_intervention_response`

Parameter	Description
`message`	Only used for custom events.
`intervention_type`	Either `selection` or `labeling`.
`data`	User response to the intervention. For more information, see POST Intervention Response.
`user_id`	ID of the user related to this intervention request.
`request_id`	ID of the intervention request to which this is a response.
`request_data`	Prompt to be shown to the user to resolve the intervention. For more information, see POST Intervention Request .
`request_message`	The intervention request message.
`request_time`	Creation time of the intervention request.
`duration_ms`	Time in ms between the intervention request and the intervention response.

Commands

`query_command_request`

Parameter	Description
`message`	Only used for custom events.
`user_id`	ID of the user related to this intervention request.
`command_id`	ID of this command instance.

`query_command_response`

Parameter	Description
`message`	Only used for custom events.
`command_id`	ID of this command instance.
`request_message`	The command request message.
`request_time`	Time at which the command was sent by the Formant web application.
`duration_ms`	Time elapsed between the command request and the command response.

`query_command_delivery`

Parameter	Description
`command_id`	ID of this command instance.
`request_message`	The command request message.
`request_time`	Time at which the command was sent by the Formant web application.
`duration_ms`	Time elapsed between the command request in the Formant web application and its receipt on the device.

Session events

`query_teleop_session_record`

Parameter	Description
`message`	Message of the event.
`intervention_type`	Internal use only, ignore.
`data`	Internal use only, ignore.
`user_id`	ID of the user associated with this teleoperation session.
`end_time`	Time at which the teleoperation session ended.
`duration_ms`	Duration in ms of the teleoperation session.

`query_port_forwarding_session_record`

Parameter	Description
`message`	Message of the event.
`intervention_type`	Internal use only, ignore.
`data`	Internal use only, ignore.
`user_id`	ID of the user associated with this port forwarding session.
`end_time`	Time at which the port forwarding session ended.
`duration_ms`	Duration in ms of the port forwarding session.

Comments and mission notation

`query_comment`

Parameter	Description
`message`	Message of the event.
`user_id`	ID of the user associated with this comment.

`query_annotation`

Parameter	Description
`message`	Message of the event.
`user_id`	ID of the user associated with this annotation.
`end_time`	Timestamp which marks the end of this annotation.
`annotation_template_id`	ID of the annotation template from which this annotation was created.
`note`	Description of this annotation.
`duration_ms`	Duration in ms between `time` and `end_time`.

`query_task_summary`

Parameter	Description
`message`	Message of the event.
`end_time`	End time of this task.
`task_summary_format_id`	ID of the task summary format from which this task summary was created.
`report`	JSON data on this task in key-value pairs.
`task_id`	ID of this task summary.
`deleted_at`	Internal use only, ignore.
`duration_ms`	Duration in ms between `time` and `end_time`.

`query_system_event`

Parameter	Description
`message`	Message of the event.
`type`	Internal use only, ignore.

Custom events

`query_custom_event`

Parameter	Description
`message`	Message of the custom event, as defined when creating the custom event with the Agent SDK or Admin API.
`severity`	Severity of the event (`info`, `warning`, `critical`, `error`).
`type`	Internal use only, ignore.

👋
If you notice an issue with this page or need help, please reach out to us! Use the 'Did this page help you?' buttons below, or get in contact with our Customer Success team via the Intercom messenger in the bottom-right corner of this page, or at [email protected].