---
title: "Sources"
method: GET
path: "/reports/sources"
tags: ["reports"]
---

# Sources

`GET /reports/sources`

## Request

- Base URL: `https://viglink.io/v1`
- URL: `https://viglink.io/v1/reports/sources`
- Auth: API key in header `authorization`

This endpoint is used to get pre-defined source aggregated data.

## Query parameters

- `clickDateStart` string, date, required
- `clickDateEnd` string, date, required
- `campaignIds` string
- `subIds` string
- `merchantGroupIds` string
- `cuids` string
- `pageUtmSource` string
- `pageUtmMedium` string
- `pageUtmCampaign` string
- `pageUtmTerm` string
- `pageUtmContent` string
- `linkUtmSource` string
- `linkUtmMedium` string
- `linkUtmCampaign` string
- `linkUtmTerm` string
- `linkUtmContent` string
- `programType` 'CPC' | 'CPA'
- `sovrnProduct` 'UNK' | 'ORG' | 'INS' | 'WRA' | 'RAC' | 'RAL' | 'CUP' | 'TPA' | 'PCR' | 'TXT' | 'SHG' | 'PRF'
- `deviceType` 'DSK' | 'MBL' | 'TBL' | 'UKN'
- `country` string

## Response `200`

successful operation

- SourceResponseModel
  - `data` object[]
    - `revenue` number
    - `clicks` number
    - `sales` number
    - `actions` number
    - `conversionRate` number
    - `epc` number
    - `cuids` string
    - `linkUtm` LinkUtmInfoModel
      - `utmSource` string
      - `utmMedium` string
      - `utmCampaign` string
      - `utmTerm` string
      - `utmContent` string
    - `pageUtm` PageUtmInfoModel
      - `utmSource` string
      - `utmMedium` string
      - `utmCampaign` string
      - `utmTerm` string
      - `utmContent` string
  - `totals` object
    - `revenueTotal` number
    - `clicksTotal` number
    - `salesTotal` number
    - `actionsTotal` number
    - `conversionRateTotal` number
    - `epcTotal` number
    - `cuidsTotal` number
    - `linkUtmTotal` number
    - `pageUtmTotal` number

## Other responses

- `400`: Bad request
- `401`: Authorization information is missing or invalid
- `404`: Source data not found
- `5XX`: Unexpected error

---

[API](https://skmtc.dev/sovrn/apis/commerce-real-time-reports.md) - [All operations](https://skmtc.dev/sovrn/apis/commerce-real-time-reports/llms.txt) - [OpenAPI document](https://skmtc.dev/sovrn/apis/commerce-real-time-reports/revisions/426d0c75e072?raw)