Mavrck Reward Wins API

openapi: 3.2.0
info:
  version: 1.0.0
  description: Identify your most influential customers and activate them to drive more conversions on social.
  title: MAVRCK.IO Reward Wins API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: RewardWins
paths:
  /influencers/{influencerId}/reward-wins:
    get:
      x-handler: reward_wins/influencer_reward_wins_controller.js
      x-access:
      - administrator
      - root
      tags:
      - RewardWins
      summary: Retrieve all reward wins for an influencer.
      operationId: getAllInfluencerRewardWins
      parameters:
      - name: influencerId
        in: path
        required: true
        schema:
          type: integer
      - name: isFulfilled
        in: query
        required: false
        schema:
          type: boolean
      - $ref: '#/components/parameters/orderByParam'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: An array of reward wins.
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RewardWin'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API Key invalid or access denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/reward-wins/fulfill-objects/bulk:
    put:
      operationId: bulkFulfillRewardWinsObjects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: number
                format: double
              type: array
        required: true
  /v1/reward-wins/fulfill-objects-with-params/bulk:
    put:
      operationId: bulkFulfillRewardWinsObjectsWithParams
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '422':
          description: Validation Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/RewardWinBulkFulfillmentParams'
              type: array
        required: true
  /v1/reward-wins/unfulfill-objects/bulk:
    put:
      operationId: bulkUnfulfillRewardWinsObjects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: number
                format: double
              type: array
        required: true
  /v1/reward-wins/update-objects/bulk:
    put:
      operationId: bulkUpdateRewardWinsObjects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/RewardWinBulkUpdateBody'
              type: array
        required: true
  /v1/reward-wins/unarchive-objects/bulk:
    put:
      operationId: bulkUnarchiveRewardWinsObjects
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              items:
                type: number
                format: double
              type: array
        required: true
  /v1/reward-wins/update-filter/bulk:
    put:
      operationId: bulkUpdateRewardWinsFilterValue
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateWithFilterRequestBody'
        required: true
  /v1/reward-wins/unarchive-filter/bulk:
    put:
      operationId: bulkUnarchiveRewardWinsFilterValue
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkMetadata'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkActionWithFilterRequestBody'
        required: true
  /v1/reward-wins:
    get:
      operationId: getAllRewardWins
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRewardWinsResponse'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: query
        name: fulfillmentStatus
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: isArchived
        required: false
        schema:
          type: boolean
      - in: query
        name: userFilterData
        required: false
        schema:
          type: string
      - in: query
        name: type
        required: false
        schema:
          type: string
          enum:
          - STRIPE
          - PAYPAL
          - MAVELY
          - TIPALTI
          - TANGO_CARDS
          - MANUAL_CASH_PAYMENT
          - MANUAL_GIFT_CARD
          - SHOPIFY_DISCOUNT
          - PRODUCT
          - PROMO_CODE
          - OTHER
          - GIFT_CARD
      - in: query
        name: q
        required: false
        schema:
          type: string
      - in: query
        name: excludedRewardWinIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: includedRewardWinIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: actionGroupId
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: daysReady
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: globalUserIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: limit
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: offset
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: orderField
        required: false
        schema:
          type: string
      - in: query
        name: orderDirection
        required: false
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - in: query
        name: includeListMember
        required: false
        schema:
          type: boolean
  /v1/reward-wins/{id}:
    put:
      operationId: updateRewardWin
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRewardWin'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
  /v1/reward-wins/{id}/fulfillment:
    put:
      operationId: fulfillRewardWin
      responses:
        '200':
          description: Fulfillment successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RewardWinFulfillmentParams'
  /v1/reward-wins/{id}/unfulfillment:
    put:
      operationId: unfulfillRewardWin
      responses:
        '200':
          description: Fulfillment successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/reward-wins/{id}/reversal:
    put:
      operationId: reverseRewardWin
      responses:
        '200':
          description: Reversal successful
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/reward-wins/{id}/void-payment:
    post:
      operationId: voidTipaltiPayment
      responses:
        '200':
          description: Payment voided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/reward-wins/{id}/unarchival:
    put:
      operationId: unarchiveRewardWin
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TSOAEmptyObject'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/reward-wins/dashboard/summary:
    get:
      operationId: getSummary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSummaryResponse'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - RewardWins
      parameters:
      - in: query
        name: fulfillmentStatus
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: isArchived
        required: false
        schema:
          type: boolean
      - in: query
        name: userFilterData
        required: false
        schema:
          type: string
      - in: query
        name: type
        required: false
        schema:
          type: string
      - in: query
        name: q
        required: false
        schema:
          type: string
      - in: query
        name: excludedRewardWinIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: includedRewardWinIds
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: actionGroupId
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: number
            format: double
      - in: query
        name: daysReady
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: limit
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: offset
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: orderField
        required: false
        schema:
          type: string
      - in: query
        name: orderDirection
        required: false
        schema:
          type: string
          enum:
          - ASC
          - DESC
components:
  schemas:
    AudienceDeprecated:
      type: object
      x-access:
      - root
      - administrator
      properties:
        id:
          type: integer
          description: Unique identifier representing a single audience.
        name:
          type: string
          description: Human-readable description of the audience displayed to administrators.
        criteria:
          type: array
          items:
            $ref: '#/components/schemas/InfluencerDataPointCriteriaDeprecated'
    GetRewardWinListMemberRewardWin:
      $ref: '#/components/schemas/Pick_ListMemberRewardWin.id-or-listMemberId-or-eligibleOnEventType_'
    ProductDeprecated:
      type: object
      properties:
        id:
          type: integer
          description: id of the product
        title:
          type: string
          description: title of the product
        description:
          type: string
          description: Description of product
        image:
          type: string
          description: product image url
        communityId:
          type: string
          description: instance to which this product belongs
        bazaarVoiceAppProduct:
          $ref: '#/components/schemas/BazaarVoiceAppProductDeprecated'
        powerReviewsPage:
          $ref: '#/components/schemas/PowerReviewsPageDeprecated'
        yotpoAppProduct:
          $ref: '#/components/schemas/YotpoAppProductDeprecated'
    PinterestAccountDeprecated:
      type: object
      properties:
        id:
          description: int = mavck-db-id, string = derived-index-id
          type:
          - integer
          - string
        username:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        profilePicture:
          type: string
        bio:
          type: string
        followersCount:
          type: integer
        followingCount:
          type: integer
        monthlyViewers:
          type: integer
        averageEngagements:
          type: integer
        engagementRate:
          type: number
        boardsCount:
          type: integer
        pinsCount:
          type: integer
        pinterestAccessGrant:
          type: object
          properties:
            isExpired:
              type: boolean
        primaryAccount:
          type: boolean
    PendingActivationURI:
      type: object
      properties:
        id:
          type: integer
    ActivationURI:
      type: object
      required:
      - id
      properties:
        id:
          type: integer
          description: Unique identifier representing the activation.
        incentive:
          $ref: '#/components/schemas/IncentiveDeprecated'
        points:
          type: number
          description: The number of points earned after activating.
    RewardWinQueryFilter:
      type: object
      properties:
        isArchived:
          type: boolean
        fulfillmentStatus:
          items:
            $ref: '#/components/schemas/FulfillmentStatusFilter'
          type: array
        type:
          type: string
        actionGroupId:
          items:
            type: number
            format: double
          type: array
        q:
          type: string
        daysReady:
          type: number
          format: double
        excludedRewardWinIds:
          items:
            type: number
            format: double
          type: array
        includedRewardWinIds:
          items:
            type: number
            format: double
          type: array
        userFilter:
          additionalProperties: true
        globalUserIds:
          items:
            type: number
            format: double
          type: array
        limit:
          type: number
          format: double
        offset:
          type: number
          format: double
        orderField:
          type: string
        orderDirection:
          type: string
          enum:
          - ASC
          - DESC
    YoutubeChannelDeprecated:
      type: object
      properties:
        id:
          description: int = mavck-db-id, string = derived-index-id
          type:
          - integer
          - string
        username:
          type: string
        bio:
          type: string
        primaryAccount:
          type: boolean
        profilePicture:
          type: string
        followersCount:
          type: integer
        youtubeExternalId:
          type: string
        videoCount:
          type: integer
        viewCount:
          type: integer
        commentCount:
          type: integer
        handle:
          type: string
    BulkActionWithFilterRequestBody:
      properties:
        rewardWinQueryFilter:
          $ref: '#/components/schemas/RewardWinQueryFilter'
      required:
      - rewardWinQueryFilter
      type: object
      additionalProperties: false
    TaxLineItem:
      properties:
        amount:
          type: number
          format: double
        type:
          $ref: '#/components/schemas/TaxLineItemType'
      required:
      - amount
      - type
      type: object
    BudgetReferenceIdType:
      type: string
      enum:
      - IROF
      - OPPORTUNITY
    RoutingOptionsDeprecated:
      type: object
      description: Routing options
      properties:
        redirect_url:
          type: string
          description: Url the influencer should be redirected to.
        cta:
          type: string
          description: Displayed CTA.
        mode:
          type: string
          description: Routing type.
    ReviewFormDeprecated:
      type: object
      required:
      - questions
      properties:
        id:
          type: integer
          description: id of form
        reviewProductId:
          type: integer
        action:
          $ref: '#/components/schemas/ActionDeprecated'
        product:
          $ref: '#/components/schemas/ProductDeprecated'
        questions:
          type: array
          description: Array of form questions
          items:
            $ref: '#/components/schemas/QuestionDeprecated'
        title:
          type: string
        description:
          type: string
        url:
          type: string
        incentivized:
          x-access:
          - administrator
          - root
          type: boolean
          description: whether the form is incentivized
        responses:
          type: array
          x-access:
          - administrator
          - root
          items:
            type: object
            properties:
              membership:
                $ref: '#/components/schemas/MembershipDeprecated'
              questionResponses:
                type: array
                items:
                  type: object
    InstagramAccountDeprecated:
      type: object
      properties:
        id:
          description: int = mavck-db-id, string = derived-index-id
          type:
          - integer
          - string
        handle:
          type: string
        fullName:
          type: string
        profilePicture:
          type: string
        bio:
          type: string
        website:
          type: string
        followersCount:
          type: integer
        followingCount:
          type: integer
        mediaCount:
          type: integer
        averageLikes:
          type: integer
        averageComments:
          type: integer
        averageEngagements:
          type: integer
        engagementRate:
          type: number
        isBusiness:
          type: boolean
        isPrivate:
          type: boolean
        sponsoredPostRate:
          type: number
        primaryAccount:
          type: boolean
        profileType:
          type: string
          enum:
          - platform
          - business


# --- truncated at 32 KB (154 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/openapi/mavrck-rewardwins-api-openapi.yml