Type Alias CaptureEventsPayloadMap

CaptureEventsPayloadMap: {
    "$query-search": {
        hits?: string[];
        query: string;
        resultCount?: number;
    };
    "$query-suggest": { query: string; suggestions?: string[] };
    "$select-category": { id: string };
    "$select-location": { id: string };
}

Maps reserved analytics event names to their payload structures.

This type is used by the Analytics.capture method to provide type safety for reserved analytics events. When using these event names, the payload must match the corresponding structure.

Type declaration

  • $query-search: { hits?: string[]; query: string; resultCount?: number }

    Event fired when a search query is executed.

    • Optionalhits?: string[]

      Optional array of result IDs (hits).

    • query: string

      The search query string.

    • OptionalresultCount?: number

      Total number of results returned for the query across all result categories (places + enterprise locations + enterprise categories). Useful for identifying queries that return no results (resultCount === 0).

  • $query-suggest: { query: string; suggestions?: string[] }

    Event fired when query suggestions are generated.

    • query: string

      The search query string.

    • Optionalsuggestions?: string[]

      Optional array of suggestion strings.

  • $select-category: { id: string }

    Event fired when a category is selected.

    • id: string

      The ID of the selected category.

  • $select-location: { id: string }

    Event fired when a location is selected.

    • id: string

      The ID of the selected location.

Settings

Member Visibility