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

# Get contest statistics

> Get comprehensive vendor contest statistics including uploads, conversions,
referrals, FB shares, opt-outs, and source breakdown (Full RMS Drip vs standalone import).
Requires the `enableVendorContests` feature to be enabled.




## OpenAPI

````yaml /openapi.yaml get /contests/stats
openapi: 3.0.3
info:
  title: RenovationFind API
  description: >
    Public REST API for RenovationFind vendor integrations.


    ## Authentication

    All endpoints require a Bearer token in the `Authorization` header.

    Tokens are issued from the RenovationFind Manager Portal.


    ```

    Authorization: Bearer <your_jwt_token>

    ```


    ## Rate Limiting

    API requests are rate-limited to **250 requests per 5 minutes** per vendor.

    When exceeded, the API returns `429 Too Many Requests` with a `Retry-After`
    header.


    ## Response Format

    All responses follow a consistent envelope:

    ```json

    {
      "success": true,
      "data": { ... },
      "message": "Optional message"
    }

    ```

    On error:

    ```json

    {
      "success": false,
      "error": "Error description"
    }

    ```
  version: 1.0.0
  contact:
    name: RenovationFind
    url: https://www.renovationfind.com
servers:
  - url: https://www.renovationfind.com/rest-api-v1
    description: Production
security:
  - BearerAuth: []
paths:
  /contests/stats:
    get:
      tags:
        - Vendor Contests
      summary: Get contest statistics
      description: >
        Get comprehensive vendor contest statistics including uploads,
        conversions,

        referrals, FB shares, opt-outs, and source breakdown (Full RMS Drip vs
        standalone import).

        Requires the `enableVendorContests` feature to be enabled.
      operationId: getContestVendorStats
      responses:
        '200':
          description: Contest statistics
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    description: Comprehensive vendor contest statistics
                    properties:
                      vendorId:
                        type: integer
                        format: int64
                      vendorName:
                        type: string
                      enableVendorContests:
                        type: boolean
                      pauseCurrentDripsInPipeline:
                        type: boolean
                      pauseVendorContestDrippingFromCFS:
                        type: boolean
                      totalAssignedLimit:
                        type: integer
                        format: int64
                        description: Maximum participants allowed
                      totalUploaded:
                        type: integer
                        format: int64
                        description: Total participants uploaded
                      totalActive:
                        type: integer
                        format: int64
                        description: Total active participants (not opted out)
                      lifetimeConversions:
                        type: integer
                        format: int64
                      optOutEmailCount:
                        type: integer
                        format: int64
                      optOutTextCount:
                        type: integer
                        format: int64
                      superUsers:
                        type: integer
                        format: int64
                        description: Participants who both shared on FB and referred others
                      totalConversions:
                        type: integer
                        format: int64
                      totalFbShares:
                        type: integer
                        format: int64
                      uniqueFbSharers:
                        type: integer
                        format: int64
                      totalReferralCount:
                        type: integer
                        format: int64
                      uniqueReferrers:
                        type: integer
                        format: int64
                      totalEntries:
                        type: integer
                        format: int64
                      rfHomeownerDbContribution:
                        type: integer
                        format: int64
                        description: Contribution to RenovationFind homeowner database
                      usersFromFullRMSDrip:
                        type: integer
                        format: int64
                        description: Participants sourced from Full RMS Drip (CFS)
                      usersFromStandaloneImport:
                        type: integer
                        format: int64
                        description: Participants sourced from standalone file imports
                      fbSharePercentage:
                        type: number
                        format: double
                        description: >-
                          Percentage of active participants who shared on
                          Facebook
                      referralParticipationPercentage:
                        type: number
                        format: double
                        description: Percentage of active participants who made referrals
                      optOutEmailRate:
                        type: number
                        format: double
                        description: Email opt-out rate
                      optOutTextRate:
                        type: number
                        format: double
                        description: Text opt-out rate
        '403':
          description: Vendor contests not enabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
        '429':
          description: Rate limit exceeded (250 requests per 5 minutes)
          headers:
            Retry-After:
              schema:
                type: integer
                example: 300
              description: Seconds to wait before retrying
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
              example:
                success: false
                error: >-
                  Rate limit exceeded. Maximum 250 requests per 5 minutes.
                  Please retry later.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token issued from the RenovationFind Manager Portal

````