> ## 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 widget analytics events

> Fire-and-forget telemetry for the embeddable store 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, `cpk_*` key prefix, referrer, query, and clicked location's `short_id`) but is not persisted to the database. Use this for usage funnels (load -> search -> click), not for billable events.



## OpenAPI

````yaml /openapi/openapi-locations.json post /locations/api/v1/public/widget-events
openapi: 3.1.0
info:
  title: Locations API
  version: 1.0.0
  description: >
    Location management for physical stores.


    ## 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: Locations
    description: Manage physical store locations.
  - name: Store Locator (Public)
    description: Public endpoints for the embeddable store locator widget.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /locations/api/v1/public/widget-events:
    post:
      tags:
        - Store Locator (Public)
      summary: Track widget analytics events
      description: >-
        Fire-and-forget telemetry for the embeddable store 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, `cpk_*` key prefix, referrer,
        query, and clicked location's `short_id`) but is not persisted to the
        database. Use this for usage funnels (load -> search -> click), not for
        billable events.
      operationId: apps_locations_api_public_track_widget_event
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WidgetEventIn'
        required: true
      responses:
        '204':
          description: No Content
components:
  schemas:
    WidgetEventIn:
      examples:
        - api_key: cpk_abc123def456
          event: location_search
          location_short_id: ''
          query: Springfield IL
          referrer: https://store.example.com
      properties:
        event:
          $ref: '#/components/schemas/WidgetEventType'
          description: >-
            Funnel stage of the widget interaction. See `WidgetEventType` for
            the allowed values.
        api_key:
          default: ''
          description: >-
            Publishable API key (`cpk_*`) that triggered the event. Only the
            first 12 characters are logged so we can attribute traffic to an org
            without storing the full key.
          title: Api Key
          type: string
        referrer:
          default: ''
          description: >-
            Page where the widget was embedded, taken from `document.referrer`.
            Truncated to 512 characters in logs.
          title: Referrer
          type: string
        query:
          default: ''
          description: >-
            Free-text search query the user typed. Set on `location_search`
            events only; ignored otherwise. Truncated to 256 characters in logs.
          title: Query
          type: string
        location_short_id:
          default: ''
          description: >-
            `short_id` of the location the user clicked through to. Set on
            `view_store_click` and `get_directions_click` events only.
          title: Location Short Id
          type: string
      required:
        - event
      title: WidgetEventIn
      type: object
    WidgetEventType:
      description: Type of widget analytics event.
      enum:
        - widget_load
        - location_search
        - view_store_click
        - get_directions_click
      examples:
        - widget_load
      title: WidgetEventType
      type: string

````