VigLink (Sovrn Commerce) reports API

openapi: 3.0.0
info:
  title: Bid Check Account reports API
  version: 1.0.0
  description: 'Use Bid Check during the click redirect flow to request a real-time bid from Sovrn for a destination URL. When Sovrn can monetize the click, Bid Check returns a redirect URL that you can use to redirect the user.


    Partners typically use Bid Check when comparing offers from multiple affiliate networks in real time. After receiving Sovrn''s bid, you can decide whether to route the click through Sovrn or through another network.


    For CPC bids, the returned `eepc` is the rate you can earn by routing the click through Sovrn before the bid expires. Sovrn''s revenue share has already been deducted from this value. For CPA offers, `eepc` is the average amount Sovrn expects you to earn per click and is not guaranteed for an individual click.


    **Note on URL encoding:** query parameter values, especially `out`, `userAgent`, `referrerUrl`, `subId`, and tracking values that contain spaces or reserved characters, must be URL-encoded when constructing the request. The `example` values below show the raw decoded form; your HTTP client or the ReadMe "Try It" panel will encode them automatically.

    '
  x-source: https://developer.sovrn.com/llms.txt (per-endpoint OpenAPI definitions, harvested 2026-07-21)
servers:
- url: https://api.viglink.com
  description: Production
tags:
- name: reports
paths:
  /reports/transactions:
    get:
      tags:
      - reports
      summary: Transactions
      description: This endpoint is used to query all commission events (transactions) that have occurred or been updated on a specified date. This data can be used to see individual link performance, actualized earnings, individual site performance and more, all in real-time.
      parameters:
      - name: clickDate
        in: query
        description: Click date for filtering
        required: false
        explode: true
        schema:
          type: string
          format: date
      - name: commissionDate
        in: query
        description: Commission date for filtering
        required: false
        explode: true
        schema:
          type: string
          format: date
      - name: updateDate
        in: query
        description: Update date for filtering
        required: false
        explode: true
        schema:
          type: string
          format: date
      - name: campaignIds
        in: query
        description: Comma separated list of campaign IDs
        required: false
        explode: true
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: merchantGroupIds
        in: query
        description: Comma separated list of merchant group IDs
        required: false
        explode: true
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: programType
        in: query
        description: Type of program (CPA/CPC)
        required: false
        explode: true
        schema:
          type: string
          enum:
          - CPC
          - CPA
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionsResponseModel'
        '400':
          description: Invalid status value
  /reports/merchants:
    get:
      tags:
      - reports
      summary: Merchants
      description: This endpoint is used to query aggregated performance metrics by Merchant. This data can be used to see individual merchant performance, your top performing merchants, actualized earnings, and more, all in real-time. Metrics include Revenue, Clicks, Sales, Actions, Conversion Rate and EPC.
      parameters:
      - name: clickDateStart
        in: query
        description: Start Date
        required: true
        schema:
          type: string
          format: date
      - name: clickDateEnd
        in: query
        description: End Date
        required: true
        schema:
          type: string
          format: date
      - name: campaignIds
        in: query
        description: Comma separated list of campaign IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: subIds
        in: query
        description: Comma separated list of sub IDs
        required: false
        schema:
          type: string
      - name: merchantGroupIds
        in: query
        description: Comma separated list of merchant group IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: cuids
        in: query
        description: Comma separated list of CUIDs (custom tracking IDs)
        required: false
        style: form
        schema:
          type: string
      - name: pageUtmSource
        in: query
        description: Comma seperated list of page UTM sources
        required: false
        schema:
          type: string
      - name: pageUtmMedium
        in: query
        description: Comma seperated list of page UTM mediums
        required: false
        schema:
          type: string
      - name: pageUtmCampaign
        in: query
        description: Comma seperated list of page UTM campaings
        required: false
        schema:
          type: string
      - name: pageUtmTerm
        in: query
        description: Comma seperated list of page UTM terms
        required: false
        schema:
          type: string
      - name: pageUtmContent
        in: query
        description: Comma seperated list of page UTM contents
        required: false
        schema:
          type: string
      - name: linkUtmSource
        in: query
        description: Comma seperated list of link UTM sources
        required: false
        schema:
          type: string
      - name: linkUtmMedium
        in: query
        description: Comma seperated list of link UTM mediums
        required: false
        schema:
          type: string
      - name: linkUtmCampaign
        in: query
        description: Comma seperated list of link UTM campaigns
        required: false
        schema:
          type: string
      - name: linkUtmTerm
        in: query
        description: Comma seperated list of link UTM terms
        required: false
        schema:
          type: string
      - name: linkUtmContent
        in: query
        description: Comma seperated list of link UTM contents
        required: false
        schema:
          type: string
      - name: programType
        in: query
        description: Type of program (CPA/CPC)
        required: false
        schema:
          type: string
          enum:
          - CPC
          - CPA
      - name: sovrnProduct
        in: query
        description: Sovrn Product
        required: false
        schema:
          $ref: '#/components/schemas/SovrnProductModel'
      - name: deviceType
        in: query
        description: Type of device
        required: false
        schema:
          $ref: '#/components/schemas/DeviceTypeModel'
      - name: country
        in: query
        description: Two-letter ISO country code
        required: false
        schema:
          type: string
          pattern: ^[A-Z]{2}$
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantsResponseModel'
        '400':
          description: Bad request
        '401':
          description: Authorization information is missing or invalid
        '404':
          description: Merchant data not found
        5XX:
          description: Unexpected error
  /reports/merchantsbydate:
    get:
      tags:
      - reports
      summary: Merchants By Date
      description: This endpoint is used to query aggregated performance metrics by Merchant and Date. This data can be used to see individual merchant performance by day, your top performing merchants, actualized earnings, and more, all in real-time. Metrics include Revenue, Clicks, Sales, Actions, Conversion Rate and EPC.
      parameters:
      - name: clickDateStart
        in: query
        description: Start Date
        required: true
        schema:
          type: string
          format: date
      - name: clickDateEnd
        in: query
        description: End Date
        required: true
        schema:
          type: string
          format: date
      - name: campaignIds
        in: query
        description: Comma separated list of campaign IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: subIds
        in: query
        description: Comma separated list of Comma separated list of sub IDs
        required: false
        schema:
          type: string
      - name: merchantGroupIds
        in: query
        description: Comma separated list of merchant group IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: cuids
        in: query
        description: Comma separated list of CUIDs (custom tracking IDs)
        required: false
        style: form
        schema:
          type: string
      - name: pageUtmSource
        in: query
        description: Comma seperated list of page UTM sources
        required: false
        schema:
          type: string
      - name: pageUtmMedium
        in: query
        description: Comma seperated list of page UTM mediums
        required: false
        schema:
          type: string
      - name: pageUtmCampaign
        in: query
        description: Comma seperated list of page UTM campaings
        required: false
        schema:
          type: string
      - name: pageUtmTerm
        in: query
        description: Comma seperated list of page UTM terms
        required: false
        schema:
          type: string
      - name: pageUtmContent
        in: query
        description: Comma seperated list of page UTM contents
        required: false
        schema:
          type: string
      - name: linkUtmSource
        in: query
        description: Comma seperated list of link UTM sources
        required: false
        schema:
          type: string
      - name: linkUtmMedium
        in: query
        description: Comma seperated list of link UTM mediums
        required: false
        schema:
          type: string
      - name: linkUtmCampaign
        in: query
        description: Comma seperated list of link UTM campaigns
        required: false
        schema:
          type: string
      - name: linkUtmTerm
        in: query
        description: Comma seperated list of link UTM terms
        required: false
        schema:
          type: string
      - name: linkUtmContent
        in: query
        description: Comma seperated list of link UTM contents
        required: false
        schema:
          type: string
      - name: programType
        in: query
        description: Type of program (CPA/CPC)
        required: false
        schema:
          type: string
          enum:
          - CPC
          - CPA
      - name: sovrnProduct
        in: query
        description: Sovrn Product
        required: false
        schema:
          $ref: '#/components/schemas/SovrnProductModel'
      - name: deviceType
        in: query
        description: Type of device
        required: false
        schema:
          $ref: '#/components/schemas/DeviceTypeModel'
      - name: country
        in: query
        description: Two-letter ISO country code
        required: false
        schema:
          type: string
          pattern: ^[A-Z]{2}$
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantsByDateResponseModel'
        '400':
          description: Bad request
        '401':
          description: Authorization information is missing or invalid
        '404':
          description: Merchant data not found
        5XX:
          description: Unexpected error
  /reports/links:
    get:
      tags:
      - reports
      summary: Links
      description: This endpoint is used to query aggregated performance metrics by Link. This data can be used to see individual merchant link performance, your top performing merchant links, actualized earnings, and more, all in real-time. Metrics include Revenue, Clicks, Sales, Actions, Conversion Rate and EPC.
      parameters:
      - name: clickDateStart
        in: query
        description: Start Date
        required: true
        schema:
          type: string
          format: date
      - name: clickDateEnd
        in: query
        description: End Date
        required: true
        schema:
          type: string
          format: date
      - name: campaignIds
        in: query
        description: Comma separated list of campaign IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: subIds
        in: query
        description: Comma separated list of Comma separated list of sub IDs
        required: false
        schema:
          type: string
      - name: merchantGroupIds
        in: query
        description: Comma separated list of merchant group IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: cuids
        in: query
        description: Comma separated list of CUIDs (custom tracking IDs)
        required: false
        style: form
        schema:
          type: string
      - name: pageUtmSource
        in: query
        description: Comma seperated list of page UTM sources
        required: false
        schema:
          type: string
      - name: pageUtmMedium
        in: query
        description: Comma seperated list of page UTM mediums
        required: false
        schema:
          type: string
      - name: pageUtmCampaign
        in: query
        description: Comma seperated list of page UTM campaings
        required: false
        schema:
          type: string
      - name: pageUtmTerm
        in: query
        description: Comma seperated list of page UTM terms
        required: false
        schema:
          type: string
      - name: pageUtmContent
        in: query
        description: Comma seperated list of page UTM contents
        required: false
        schema:
          type: string
      - name: linkUtmSource
        in: query
        description: Comma seperated list of link UTM sources
        required: false
        schema:
          type: string
      - name: linkUtmMedium
        in: query
        description: Comma seperated list of link UTM mediums
        required: false
        schema:
          type: string
      - name: linkUtmCampaign
        in: query
        description: Comma seperated list of link UTM campaigns
        required: false
        schema:
          type: string
      - name: linkUtmTerm
        in: query
        description: Comma seperated list of link UTM terms
        required: false
        schema:
          type: string
      - name: linkUtmContent
        in: query
        description: Comma seperated list of link UTM contents
        required: false
        schema:
          type: string
      - name: programType
        in: query
        description: Type of program (CPA/CPC)
        required: false
        schema:
          type: string
          enum:
          - CPC
          - CPA
      - name: sovrnProduct
        in: query
        description: Sovrn Product
        required: false
        schema:
          $ref: '#/components/schemas/SovrnProductModel'
      - name: deviceType
        in: query
        description: Type of device
        required: false
        schema:
          $ref: '#/components/schemas/DeviceTypeModel'
      - name: country
        in: query
        description: Two-letter ISO country code
        required: false
        schema:
          type: string
          pattern: ^[A-Z]{2}$
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinksResponseModel'
        '400':
          description: Bad request
        '401':
          description: Authorization information is missing or invalid
        '404':
          description: Links data not found
        5XX:
          description: Unexpected error
  /reports/pages:
    get:
      tags:
      - reports
      summary: Pages
      description: This endpoint is used to query aggregated performance metrics by Page. This data can be used to see individual page performance, your top performing pages, actualized earnings, and more, all in real-time. Metrics include Pageviews, RPM, Revenue, Clicks, Sales, Actions, Conversion Rate and EPC.
      parameters:
      - name: clickDateStart
        in: query
        description: Start Date
        required: true
        schema:
          type: string
          format: date
      - name: clickDateEnd
        in: query
        description: End Date
        required: true
        schema:
          type: string
          format: date
      - name: campaignIds
        in: query
        description: Comma separated list of campaign IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: subIds
        in: query
        description: Comma separated list of sub IDs
        required: false
        schema:
          type: string
      - name: merchantGroupIds
        in: query
        description: Comma separated list of merchant group IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: cuids
        in: query
        description: Comma separated list of CUIDs (custom tracking IDs)
        required: false
        style: form
        schema:
          type: string
      - name: pageUtmSource
        in: query
        description: Comma seperated list of page UTM sources
        required: false
        schema:
          type: string
      - name: pageUtmMedium
        in: query
        description: Comma seperated list of page UTM mediums
        required: false
        schema:
          type: string
      - name: pageUtmCampaign
        in: query
        description: Comma seperated list of page UTM campaings
        required: false
        schema:
          type: string
      - name: pageUtmTerm
        in: query
        description: Comma seperated list of page UTM terms
        required: false
        schema:
          type: string
      - name: pageUtmContent
        in: query
        description: Comma seperated list of page UTM contents
        required: false
        schema:
          type: string
      - name: linkUtmSource
        in: query
        description: Comma seperated list of link UTM sources
        required: false
        schema:
          type: string
      - name: linkUtmMedium
        in: query
        description: Comma seperated list of link UTM mediums
        required: false
        schema:
          type: string
      - name: linkUtmCampaign
        in: query
        description: Comma seperated list of link UTM campaigns
        required: false
        schema:
          type: string
      - name: linkUtmTerm
        in: query
        description: Comma seperated list of link UTM terms
        required: false
        schema:
          type: string
      - name: linkUtmContent
        in: query
        description: Comma seperated list of link UTM contents
        required: false
        schema:
          type: string
      - name: programType
        in: query
        description: Type of program (CPA/CPC)
        required: false
        schema:
          type: string
          enum:
          - CPC
          - CPA
      - name: sovrnProduct
        in: query
        description: Sovrn Product
        required: false
        schema:
          $ref: '#/components/schemas/SovrnProductModel'
      - name: deviceType
        in: query
        description: Type of device
        required: false
        schema:
          $ref: '#/components/schemas/DeviceTypeModel'
      - name: country
        in: query
        description: Two-letter ISO country code
        required: false
        schema:
          type: string
          pattern: ^[A-Z]{2}$
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagesResponseModel'
        '400':
          description: Bad request
        '401':
          description: Authorization information is missing or invalid
        '404':
          description: Page data not found
        5XX:
          description: Unexpected error
  /reports/merchandise:
    get:
      tags:
      - reports
      summary: Merchandise
      description: This endpoint is used to query aggregated performance metrics by Merchandise. This data can be used to see individual product performance, your top performing products, actualized earnings, and more, all in real-time. Metrics include Revenue, Sales, and Actions.
      parameters:
      - name: clickDateStart
        in: query
        description: Start Date
        required: true
        schema:
          type: string
          format: date
      - name: clickDateEnd
        in: query
        description: End Date
        required: true
        schema:
          type: string
          format: date
      - name: campaignIds
        in: query
        description: Comma separated list of campaign IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: subIds
        in: query
        description: Comma separated list of sub IDs
        required: false
        schema:
          type: string
      - name: merchantGroupIds
        in: query
        description: Comma separated list of merchant group IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: cuids
        in: query
        description: Comma separated list of CUIDs (custom tracking IDs)
        required: false
        style: form
        schema:
          type: string
      - name: pageUtmSource
        in: query
        description: Comma seperated list of page UTM sources
        required: false
        schema:
          type: string
      - name: pageUtmMedium
        in: query
        description: Comma seperated list of page UTM mediums
        required: false
        schema:
          type: string
      - name: pageUtmCampaign
        in: query
        description: Comma seperated list of page UTM campaings
        required: false
        schema:
          type: string
      - name: pageUtmTerm
        in: query
        description: Comma seperated list of page UTM terms
        required: false
        schema:
          type: string
      - name: pageUtmContent
        in: query
        description: Comma seperated list of page UTM contents
        required: false
        schema:
          type: string
      - name: linkUtmSource
        in: query
        description: Comma seperated list of link UTM sources
        required: false
        schema:
          type: string
      - name: linkUtmMedium
        in: query
        description: Comma seperated list of link UTM mediums
        required: false
        schema:
          type: string
      - name: linkUtmCampaign
        in: query
        description: Comma seperated list of link UTM campaigns
        required: false
        schema:
          type: string
      - name: linkUtmTerm
        in: query
        description: Comma seperated list of link UTM terms
        required: false
        schema:
          type: string
      - name: linkUtmContent
        in: query
        description: Comma seperated list of link UTM contents
        required: false
        schema:
          type: string
      - name: programType
        in: query
        description: Type of program (CPA/CPC)
        required: false
        schema:
          type: string
          enum:
          - CPC
          - CPA
      - name: sovrnProduct
        in: query
        description: Sovrn Product
        required: false
        schema:
          $ref: '#/components/schemas/SovrnProductModel'
      - name: deviceType
        in: query
        description: Type of device
        required: false
        schema:
          $ref: '#/components/schemas/DeviceTypeModel'
      - name: country
        in: query
        description: Two-letter ISO country code
        required: false
        schema:
          type: string
          pattern: ^[A-Z]{2}$
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchandiseResponseModel'
        '400':
          description: Bad request
        '401':
          description: Authorization information is missing or invalid
        '404':
          description: Merchandise data not found
        5XX:
          description: Unexpected error
  /reports/networks:
    get:
      tags:
      - reports
      summary: Networks
      description: This endpoint is used to query aggregated performance metrics by Network. This data can be used to see connected Network performance, your top performing Networks, actualized earnings, and more, all in real-time. Metrics include Revenue, Clicks, Sales, Actions and EPC.
      parameters:
      - name: clickDateStart
        in: query
        description: Start Date
        required: true
        schema:
          type: string
          format: date
      - name: clickDateEnd
        in: query
        description: End Date
        required: true
        schema:
          type: string
          format: date
      - name: campaignIds
        in: query
        description: Comma separated list of campaign IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: subIds
        in: query
        description: Comma separated list of sub IDs
        required: false
        schema:
          type: string
      - name: merchantGroupIds
        in: query
        description: Comma separated list of merchant group IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: cuids
        in: query
        description: Comma separated list of CUIDs (custom tracking IDs)
        required: false
        style: form
        schema:
          type: string
      - name: pageUtmSource
        in: query
        description: Comma seperated list of page UTM sources
        required: false
        schema:
          type: string
      - name: pageUtmMedium
        in: query
        description: Comma seperated list of page UTM mediums
        required: false
        schema:
          type: string
      - name: pageUtmCampaign
        in: query
        description: Comma seperated list of page UTM campaings
        required: false
        schema:
          type: string
      - name: pageUtmTerm
        in: query
        description: Comma seperated list of page UTM terms
        required: false
        schema:
          type: string
      - name: pageUtmContent
        in: query
        description: Comma seperated list of page UTM contents
        required: false
        schema:
          type: string
      - name: linkUtmSource
        in: query
        description: Comma seperated list of link UTM sources
        required: false
        schema:
          type: string
      - name: linkUtmMedium
        in: query
        description: Comma seperated list of link UTM mediums
        required: false
        schema:
          type: string
      - name: linkUtmCampaign
        in: query
        description: Comma seperated list of link UTM campaigns
        required: false
        schema:
          type: string
      - name: linkUtmTerm
        in: query
        description: Comma seperated list of link UTM terms
        required: false
        schema:
          type: string
      - name: linkUtmContent
        in: query
        description: Comma seperated list of link UTM contents
        required: false
        schema:
          type: string
      - name: programType
        in: query
        description: Type of program (CPA/CPC)
        required: false
        schema:
          type: string
          enum:
          - CPC
          - CPA
      - name: sovrnProduct
        in: query
        description: Sovrn Product
        required: false
        schema:
          $ref: '#/components/schemas/SovrnProductModel'
      - name: deviceType
        in: query
        description: Type of device
        required: false
        schema:
          $ref: '#/components/schemas/DeviceTypeModel'
      - name: country
        in: query
        description: Two-letter ISO country code
        required: false
        schema:
          type: string
          pattern: ^[A-Z]{2}$
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkResponseModel'
        '400':
          description: Bad request
        '401':
          description: Authorization information is missing or invalid
        '404':
          description: Network data not found
        5XX:
          description: Unexpected error
  /reports/cuids:
    get:
      tags:
      - reports
      summary: CUIDs
      description: This endpoint is used to query aggregated performance metrics by CUID. This data can be used to see individual CUID performance, your top performing CUIDs, actualized earnings, and more, all in real-time. Metrics include Revenue, Clicks, Sales, Actions, Conversion Rate and EPC.
      parameters:
      - name: clickDateStart
        in: query
        description: Start Date
        required: true
        schema:
          type: string
          format: date
      - name: clickDateEnd
        in: query
        description: End Date
        required: true
        schema:
          type: string
          format: date
      - name: campaignIds
        in: query
        description: Comma separated list of campaign IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: subIds
        in: query
        description: Comma separated list of sub IDs
        required: false
        schema:
          type: string
      - name: merchantGroupIds
        in: query
        description: Comma separated list of merchant group IDs
        required: false
        schema:
          type: string
          pattern: ^[0-9,]+$
      - name: cuids
        in: query
        description: Comma separated list of CUIDs (custom tracking IDs)
        required: false
        style: form
        schema:
          type: string
      - name: pageUtmSource
        in: query
        description: Comma seperated list of page UTM sources
        required: false
        schema:
          type: string
      - name: pageUtmMedium
        in: query
        description: Comma seperated list of page UTM mediums
        required: false
        schema:
          type: string
      - name: pageUtmCampaign
        in: query
        description: Comma seperated list of page UTM campaings
        required: false
        schema:
          type: string
      - name: pageUtmTerm
        in: query
        description: Comma seperated list of page UTM terms
        required: false
        schema:
          type: string
      - name: pageUtmContent
        in: query
        description: Comma seperated list of page UTM contents
        required: false
        schema:
          type: string
      - name: linkUtmSource
        in: query
        description: Comma seperated list of link UTM sources
        required: false
        schema:
          type: string
      - name: linkUtmMedium
        in: query
        description: Comma seperated list of link UTM mediums
        required: false
        schema:
          type: string
      - name: linkUtmCampaign
        in: query
        description: Comma seperated list of link UTM campaigns
        required: false
        schema:
          type: string
      - name: linkUtmTerm
        in: query
        description: Comma seperated list of link UTM terms
        required: false
        schema:
          type: string
      - n

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