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

# Get Custom Scrub Rate

> Retrieve a single custom scrub rate setting by its ID.




## OpenAPI

````yaml openapi/custom-scrub-rates.yaml get /networks/custom/scrubrate/{settingId}
openapi: 3.0.3
info:
  title: Everflow Network API - Custom Scrub Rates
  description: >
    Endpoints for managing custom scrub rate (throttle) settings in the Everflow
    network. The scrub rate mechanism automatically rejects a percentage of
    conversions for specific affiliate/offer combinations. For more details, see
    the [Performance Data Adjustments
    guide](https://helpdesk.everflow.io/customer/performance-data-adjustments-clicks-conversions-revenue-payout).
  version: 1.0.0
servers:
  - url: https://api.eflow.team/v1
security: []
tags:
  - name: Custom Scrub Rates
paths:
  /networks/custom/scrubrate/{settingId}:
    get:
      tags:
        - Custom Scrub Rates
      summary: Get Custom Scrub Rate by ID
      description: |
        Retrieve a single custom scrub rate setting by its ID.
      parameters:
        - in: path
          name: settingId
          required: true
          schema:
            type: integer
          description: The custom scrub rate setting identifier.
        - in: query
          name: relationship
          schema:
            type: string
            enum:
              - all
          description: >-
            Set to `all` to include expanded relationship data (`ruleset`,
            `variables`) in the response. Without this parameter, only
            `affiliate` and `offer` are returned.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomScrubRate'
      security:
        - API Key: []
components:
  schemas:
    CustomScrubRate:
      type: object
      properties:
        network_custom_scrub_rate_setting_id:
          type: integer
          description: Unique custom scrub rate setting ID.
        network_id:
          type: integer
          description: Network ID.
        network_offer_id:
          type: integer
          description: Associated offer ID.
        network_affiliate_id:
          type: integer
          description: Associated affiliate ID.
        name:
          type: string
          description: Display name for this custom scrub rate setting.
        custom_setting_status:
          type: string
          enum:
            - active
            - inactive
          description: Setting status.
        scrub_rate_percentage:
          type: integer
          description: >
            The percentage of conversions that will be affected by this setting
            (0-100). Note that each conversion has the specified percentage
            chance of being scrubbed, rather than guaranteeing that exactly that
            percentage will be scrubbed.
        scrub_rate_status:
          type: string
          enum:
            - rejected
            - pending
          description: >
            How the setting affects the conversions it targets. `pending` marks
            conversions as pending; `rejected` rejects them immediately.
        time_created:
          type: integer
          example: 1734455015
          description: Unix timestamp of creation.
        time_saved:
          type: integer
          example: 1734455015
          description: Unix timestamp of last update.
        relationship:
          type: object
          properties:
            affiliate:
              type: object
              description: Associated affiliate details.
              properties:
                network_affiliate_id:
                  type: integer
                network_id:
                  type: integer
                name:
                  type: string
                account_status:
                  type: string
                network_employee_id:
                  type: integer
                internal_notes:
                  type: string
                has_notifications:
                  type: boolean
                network_traffic_source_id:
                  type: integer
                account_executive_id:
                  type: integer
                adress_id:
                  type: integer
                default_currency_id:
                  type: string
                is_contact_address_enabled:
                  type: boolean
                enable_media_cost_tracking_links:
                  type: boolean
                time_created:
                  type: integer
                  example: 1734455015
                time_saved:
                  type: integer
                  example: 1734455015
                referrer_id:
                  type: integer
            offer:
              type: object
              description: Associated offer details.
              properties:
                network_offer_id:
                  type: integer
                network_id:
                  type: integer
                network_advertiser_id:
                  type: integer
                network_offer_group_id:
                  type: integer
                name:
                  type: string
                offer_status:
                  type: string
                network_tracking_domain_id:
                  type: integer
                visibility:
                  type: string
                currency_id:
                  type: string
            ruleset:
              type: object
              description: >
                Targeting ruleset applied to this setting. Contains geographic,
                device, browser, and connection targeting rules. See the
                [Ruleset guide](/user-guide/rulesets) for details.
            variables:
              type: object
              description: Variable matching rules associated with this scrub rate setting.
              properties:
                total:
                  type: integer
                  description: Total number of variables.
                entries:
                  type: array
                  description: List of variable conditions.
                  items:
                    type: object
                    properties:
                      network_custom_scrub_rate_setting_variable_id:
                        type: integer
                        description: Unique variable ID.
                      network_custom_scrub_rate_setting_id:
                        type: integer
                        description: The parent custom scrub rate setting ID.
                      comparison_method:
                        type: string
                        description: How to compare the variable against the value.
                      variable:
                        type: string
                        description: The parameter name.
                      variable_value:
                        type: string
                        description: The value to compare against.
                      variable_secondary_value:
                        type: string
                        description: A secondary value used with range-based comparisons.
  securitySchemes:
    API Key:
      description: The Everflow API key generated from the Control Center > Security.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````