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

# Record one product-analytics event for a merchant

> Sends one PostHog event (`type`, with `payload` as its properties) attributed to the caller and grouped under the merchant. Call it for in-app user actions worth counting; it is fire-and-forget, so nothing is read back. Side effect: one PostHog capture, sent after the response. Returns JSON `null`.



## OpenAPI

````yaml /api-reference/openapi/lite.json post /arm
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /arm:
    post:
      summary: Record one product-analytics event for a merchant
      description: >-
        Sends one PostHog event (`type`, with `payload` as its properties)
        attributed to the caller and grouped under the merchant. Call it for
        in-app user actions worth counting; it is fire-and-forget, so nothing is
        read back. Side effect: one PostHog capture, sent after the response.
        Returns JSON `null`.
      operationId: armTrack
      parameters:
        - schema:
            type: string
            description: Lite merchant id, e.g. `shopify-<shop id>`.
          required: true
          description: Lite merchant id, e.g. `shopify-<shop id>`.
          name: merchant_id
          in: query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackRequest'
      responses:
        '200':
          description: Accepted; the event is sent behind the response.
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: The query or body failed the schema, or the body is not JSON.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '404':
          description: Merchant not found for this caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '415':
          description: Content-Type is not application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    TrackRequest:
      type: object
      properties:
        type:
          type: string
          description: >-
            The PostHog event name, e.g. `collection_opened`. Sent verbatim as
            the event.
        payload:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
              - type: 'null'
          description: >-
            Event properties: string, string-list or null values only. The
            request's PostHog-Session-ID and Referer headers are merged over it
            as `$session_id` / `$referrer`.
      required:
        - type
        - payload
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Shopify App Bridge session token of the embedded Depict: Search &
        Merchandising app. The shop in the token determines the merchant;
        merchant_id parameters must belong to that shop.

````