DataAssist-IO Marketer API

openapi: 3.2.0
info:
  title: DataAssist-IO Server Marketer API
  version: 0.1.0
tags:
- name: Marketer
paths:
  /marketer:
    get:
      summary: Spa Marketer Root
      operationId: spa_marketer_root_marketer_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Marketer
  /marketer/{rest}:
    get:
      summary: Spa Marketer Sub
      operationId: spa_marketer_sub_marketer__rest__get
      parameters:
      - name: rest
        in: path
        required: true
        schema:
          type: string
          title: Rest
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Marketer
  /api/marketer/codes:
    get:
      tags:
      - Marketer
      summary: List My Codes
      description: 'The caller''s org''s promo codes — full detail for the dashboard table.


        All counters surface ONLY successful outcomes — failed checkouts

        (Razorpay decline, abandoned modal, etc.) leave their application row

        for audit but are deliberately invisible to the marketer because they

        don''t represent real conversions or earnings.'
      operationId: list_my_codes_api_marketer_codes_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/marketer/codes/{promo_id}/signups:
    get:
      tags:
      - Marketer
      summary: List Signups For Code
      description: 'Orgs that signed up with the caller''s promo code.


        SCOPE GUARD: the WHERE filter binds promo_code_id to the caller''s

        marketer_org_id so a marketer can''t read another marketer''s signups

        by guessing IDs.


        PII rule: returns slug + name only. No admin emails, no internal org_ids.'
      operationId: list_signups_for_code_api_marketer_codes__promo_id__signups_get
      parameters:
      - name: promo_id
        in: path
        required: true
        schema:
          type: integer
          title: Promo Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/marketer/codes/{promo_id}/applications:
    get:
      tags:
      - Marketer
      summary: List Applications For Code
      description: 'Every checkout that applied this code, with purchase + commission status.


        Where /signups answers "who signed up via this URL?", /applications

        answers "who actually used this code at checkout?" — including manual

        entry, failed payment attempts, and completed sales. This is the

        marketer''s performance view per code.


        SCOPE GUARD: the promo code must belong to the caller''s marketing org.

        Returns 404 otherwise. Same PII rule as /signups — slug + name only,

        never admin email or internal org_id.


        Failed applications (Razorpay decline, abandoned modal) are filtered

        out — they''re kept in the DB for audit but invisible to the marketer

        because they represent no real outcome (no money, no commission).'
      operationId: list_applications_for_code_api_marketer_codes__promo_id__applications_get
      parameters:
      - name: promo_id
        in: path
        required: true
        schema:
          type: integer
          title: Promo Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/marketer/earnings:
    get:
      tags:
      - Marketer
      summary: Get Earnings Summary
      description: Aggregate earnings for the marketing-org dashboard's headline card.
      operationId: get_earnings_summary_api_marketer_earnings_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/marketer/earnings/transactions:
    get:
      tags:
      - Marketer
      summary: List Commissions
      description: Per-row commission ledger.
      operationId: list_commissions_api_marketer_earnings_transactions_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/marketer/earnings/transactions.csv:
    get:
      tags:
      - Marketer
      summary: Commissions Csv
      operationId: commissions_csv_api_marketer_earnings_transactions_csv_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError