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

# Track a click

> Server-to-server click. Requires `track` (or `*`) scope. `ref` is required.



## OpenAPI

````yaml /openapi.yaml post /v1/track/click
openapi: 3.1.0
info:
  title: Affixo API
  version: 1.0.0
  description: |
    The Affixo REST API for affiliate program management and server-to-server
    conversion tracking.

    There are two families of bearer tokens:

    - **Workspace keys** (`sa_live_…`) — full program access, scoped by
      `read` / `write` / `track`. Used for the management and tracking endpoints.
    - **Affiliate keys** (`refa_live_…`) — read-only, return **only the calling
      affiliate's own data**. Used for the `/v1/affiliate/*` endpoints.

    Tokens are sent as `Authorization: Bearer <token>`. Rate limit: 600 req/min
    per key (enforced at the edge).
servers:
  - url: https://go.affixo.dev
    description: Production
security: []
tags:
  - name: Affiliates
    description: Manage affiliates (workspace key)
  - name: Links
    description: Manage referral links (workspace key)
  - name: Resources
    description: Read campaigns, commissions, conversions, payouts (workspace key)
  - name: Tracking
    description: >-
      Server-to-server click & conversion tracking (workspace key, scope
      "track")
  - name: Affiliate
    description: Read-only, self-scoped endpoints (affiliate key)
paths:
  /v1/track/click:
    post:
      tags:
        - Tracking
      summary: Track a click
      description: >-
        Server-to-server click. Requires `track` (or `*`) scope. `ref` is
        required.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - ref
              properties:
                ref:
                  type: string
                  description: Referral code / ref_param.
                  example: jane
                visitor_id:
                  type: string
                  nullable: true
                fingerprint:
                  type: string
                  nullable: true
                url:
                  type: string
                  format: uri
                  nullable: true
                referrer:
                  type: string
                  nullable: true
      responses:
        '200':
          description: Click recorded
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
                  visitor_id:
                    type: string
                  match_method:
                    type: string
                    example: cookie
                  match_confidence:
                    type: number
                    format: float
                    example: 1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - WorkspaceKey: []
components:
  responses:
    BadRequest:
      description: Invalid or missing parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_json
    Unauthorized:
      description: Missing or invalid bearer token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
    NotFound:
      description: Resource not found / not in workspace
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: link_not_found
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        need:
          type: string
          description: Present on insufficient_scope.
        detail:
          type: string
  securitySchemes:
    WorkspaceKey:
      type: http
      scheme: bearer
      description: 'Workspace API key, e.g. `sa_live_…`. Scopes: read / write / track / *.'

````