> ## Documentation Index
> Fetch the complete documentation index at: https://docs.closient.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Track brand locator widget events

> Fire-and-forget telemetry for the embeddable brand product locator widget. Designed for `navigator.sendBeacon()` and background `fetch()` calls — no auth, no rate limit, always returns `204 No Content`. The body is structured-logged server-side (event type, brand id, referrer, product id, store id, query) but is not persisted to the database. Unknown event types are silently ignored.



## OpenAPI

````yaml /openapi/openapi-brands.json post /brands/api/v1/public/widget-events
openapi: 3.1.0
info:
  title: Brands API
  version: 1.0.0
  description: >
    Brand management: list, create, update, and manage brand profiles.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Brands
    description: Brand CRUD operations.
  - name: Brand Locator (Public)
    description: >-
      Unauthenticated endpoints that power the embeddable brand product-locator
      widget (C-1803). Mounted under the `/public/` prefix so the widget CORS
      middleware opens CORS for them.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /brands/api/v1/public/widget-events:
    post:
      tags:
        - Brand Locator (Public)
      summary: Track brand locator widget events
      description: >-
        Fire-and-forget telemetry for the embeddable brand product locator
        widget. Designed for `navigator.sendBeacon()` and background `fetch()`
        calls — no auth, no rate limit, always returns `204 No Content`. The
        body is structured-logged server-side (event type, brand id, referrer,
        product id, store id, query) but is not persisted to the database.
        Unknown event types are silently ignored.
      operationId: apps_brands_api_public_track_brand_locator_event
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandLocatorEventIn'
        required: true
      responses:
        '204':
          description: No Content
components:
  schemas:
    BrandLocatorEventIn:
      description: Fire-and-forget analytics event from the brand locator widget.
      examples:
        - brand_id: 2sP1Y9pZ4xQ6rNvHwT3kBe
          event: store_click
          product_id: ''
          query: ''
          referrer: https://acme.example.com/where-to-buy
          store_id: 5kY2Z9wPqRtXvNbHcMjA1d
      properties:
        event:
          description: >-
            Funnel stage of the widget interaction. Accepted values:
            `widget_load`, `location_search`, `product_filter_change`,
            `store_click`, `get_directions_click`.
          title: Event
          type: string
        brand_id:
          default: ''
          description: >-
            Brand short id the widget is rendering. Empty when unknown (e.g.
            widget script load before init).
          title: Brand Id
          type: string
        referrer:
          default: ''
          description: >-
            Page where the widget was embedded, taken from `document.referrer`.
            Truncated to 512 characters.
          title: Referrer
          type: string
        product_id:
          default: ''
          description: >-
            Brand catalog product short id, set on `product_filter_change`
            events. Empty otherwise. Truncated to 128 characters.
          title: Product Id
          type: string
        store_id:
          default: ''
          description: >-
            Physical store short id, set on `store_click` and
            `get_directions_click` events. Empty otherwise. Truncated to 128
            characters.
          title: Store Id
          type: string
        query:
          default: ''
          description: >-
            Free-text search query the user typed. Set on `location_search`
            events only. Truncated to 256 characters.
          title: Query
          type: string
      required:
        - event
      title: BrandLocatorEventIn
      type: object

````