# AnalyticsFunction

**Type**: `object`

## Properties

- name: aggregate (optional)
  type: boolean

- name: category (optional)
  type: string
  description: Function family used to group completions.

- name: completions (optional)
  type: array of `AnalyticsCompletion`
  description: User-facing completion templates for this function.

- name: examples (optional)
  type: array of `AnalyticsExample`
  description: Example calls demonstrating the function.

- name: help (required)
  type: string
  description: Short user-facing explanation shown with completions.

- name: keywordSyntax (optional)
  type: boolean
  description: True when the call is written with SQL keywords rather than a comma-separated argument list, e.g. CAST(value AS type) or EXTRACT(field FROM timestamp). Show the examples rather than a signature synthesized from parameters.

- name: maxArgs (optional)
  type: integer
  description: Null for variadic functions.

- name: minArgs (optional)
  type: integer
  description: Null for variadic functions.

- name: name (required)
  type: string

- name: parameters (optional)
  type: array of `AnalyticsParameter`
  description: The function's arguments in call order, for rendering a signature. Required arguments precede optional ones.