Clarity Survey Distribution API

openapi: 3.2.0
info:
  title: Fast Survey Distribution API
  version: 0.1.0
tags:
- name: survey-distribution
paths:
  /api/v1/anecdote-surveys/{anecdote_survey_id}/send:
    post:
      tags:
      - survey-distribution
      summary: Send Distribution
      description: 'Send a survey invitation over a phone-based channel (SMS / WhatsApp).


        Resolves recipients from ``contact_list_id`` (members'' phones) and/or inline

        ``recipients``, builds a per-recipient tracked survey link, and sends via the

        chosen channel adapter.


        Args:

        anecdote_survey_id: The VoC anecdote survey id.

        body: ``channel`` (''sms'' | ''whatsapp''), optional ``contact_list_id`` and/or

        ``recipients``, and an optional custom ``message``.


        Returns:

        ``{channel, sent, failed, results: [...]}``.


        Raises:

        HTTPException: 400 on bad input or unconfigured/unsupported channel;

        404 if the survey or contact list is not found.'
      operationId: send_distribution_api_v1_anecdote_surveys__anecdote_survey_id__send_post
      security:
      - HTTPBearer: []
      parameters:
      - name: anecdote_survey_id
        in: path
        required: true
        schema:
          type: integer
          title: Anecdote Survey Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendDistributionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/anecdote-surveys/{anecdote_survey_id}/qr:
    post:
      tags:
      - survey-distribution
      summary: Create Qr Link
      description: 'Create (or return the existing) trackable QR distribution link for a survey.


        The QR image is rendered client-side from ``tracking_url``; survey-api owns

        the trackable URL + scan counters. Idempotent: repeat calls return the same

        live link.


        Returns:

        ``{token, tracking_url, target_url}``.


        Raises:

        HTTPException: 404 if the survey is not found; 400 if its public id is missing

        or survey-api rejects the request.'
      operationId: create_qr_link_api_v1_anecdote_surveys__anecdote_survey_id__qr_post
      security:
      - HTTPBearer: []
      parameters:
      - name: anecdote_survey_id
        in: path
        required: true
        schema:
          type: integer
          title: Anecdote Survey Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/anecdote-surveys/{anecdote_survey_id}/qr/stats:
    get:
      tags:
      - survey-distribution
      summary: Qr Stats
      description: Return the survey's distribution links with scan counts / last-scanned times.
      operationId: qr_stats_api_v1_anecdote_surveys__anecdote_survey_id__qr_stats_get
      security:
      - HTTPBearer: []
      parameters:
      - name: anecdote_survey_id
        in: path
        required: true
        schema:
          type: integer
          title: Anecdote Survey Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SendDistributionRequest:
      properties:
        channel:
          type: string
          title: Channel
        contact_list_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Contact List Id
        recipients:
          anyOf:
          - items:
              $ref: '#/components/schemas/InlineRecipient'
            type: array
          - type: 'null'
          title: Recipients
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
      type: object
      required:
      - channel
      title: SendDistributionRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    InlineRecipient:
      properties:
        phone:
          type: string
          title: Phone
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        attributes:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Attributes
      type: object
      required:
      - phone
      title: InlineRecipient
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic