Interface: UseAnalyticsQueryOptions\<F\>
Options for configuring an analytics SSE query
Type Parameters
Section titled “Type Parameters”F extends AnalyticsFormat = "JSON_ARRAY"
Properties
Section titled “Properties”autoStart?
Section titled “autoStart?”
optionalautoStart?:boolean
Whether to automatically start the query when the hook is mounted. Default is true.
format?
Section titled “format?”
optionalformat?:F
Response format - “JSON_ARRAY” (default) returns typed arrays, “ARROW_STREAM” uses Arrow (inline or external links)
maxParametersSize?
Section titled “maxParametersSize?”
optionalmaxParametersSize?:number
Maximum size of serialized parameters in bytes