---
title: "Campaign performance + variants"
method: GET
path: "/api/v1/reports/campaigns/{id}"
tags: ["Reports"]
---

# Campaign performance + variants

`GET /api/v1/reports/campaigns/{id}`

## Request

- Base URL: `https://app.convertflow.co`
- URL: `https://app.convertflow.co/api/v1/reports/campaigns/{id}`
- Auth: HTTP bearer

## Query parameters

- `website_id` integer
- `timeframe` 'today' | 'this_week' | 'this_month' | 'this_quarter' | 'this_year' | 'last_24_hours' | 'last_7_days' | 'last_30_days' | 'last_90_days' | 'last_365_days' | 'all_time' | 'insights_week' | 'custom'
- `range_start` string, date
- `range_end` string, date
- `count_type` 'distinct' | 'total'
- `previous_period` boolean
- `group_by` 'day' | 'week' | 'month' | 'quarter' | 'year'

## Response `200`

campaign with variant breakdown

- object
  - `report` string
  - `website` object
    - `id` integer
    - `name` string
    - `currency` string
  - `timeframe` object
    - `selected` string
    - `range_start` string, date-time
    - `range_end` string, date-time
    - `timezone` string
    - `previous_range_start` string, date-time
    - `previous_range_end` string, date-time
  - `data` object
    - `id` integer
    - `name` string
    - `cta_type` string: Campaign format
    - `status` string
    - `metrics` object
      - `views` integer
      - `conversions` integer
      - `completions` integer
      - `submissions` integer
      - `subscribes` integer
      - `orders` integer
      - `bookings` integer
      - `custom_goals` integer
      - `revenue` number
      - `conversion_rate` number
      - `completion_rate` number
      - `subscribe_rate` number
      - `order_rate` number
      - `booking_rate` number
      - `custom_goal_rate` number
      - `aov` number
      - `previous` object
        - `views` integer
        - `conversions` integer
        - `completions` integer
        - `submissions` integer
        - `subscribes` integer
        - `orders` integer
        - `bookings` integer
        - `custom_goals` integer
        - `revenue` number
        - `conversion_rate` number
        - `completion_rate` number
        - `subscribe_rate` number
        - `order_rate` number
        - `booking_rate` number
        - `custom_goal_rate` number
        - `aov` number
      - `changes` object
        - `views` number
        - `conversions` number
        - `completions` unknown
        - `submissions` unknown
        - `subscribes` unknown
        - `orders` unknown
        - `bookings` unknown
        - `custom_goals` unknown
        - `revenue` unknown
        - `conversion_rate` number
        - `completion_rate` unknown
        - `subscribe_rate` unknown
        - `order_rate` unknown
        - `booking_rate` unknown
        - `custom_goal_rate` unknown
        - `aov` unknown
    - `timeseries` object
      - `group_by` string
      - `points` object[]
        - `date` string, date
        - `views` integer
        - `conversions` integer
        - `completions` integer
        - `subscribes` integer
        - `submissions` integer
        - `bookings` integer
        - `custom_goals` integer
        - `orders` integer
        - `revenue` number
    - `variants` object[]
      - `id` integer
      - `name` unknown
      - `variation` string
      - `traffic_percentage` integer
      - `metrics` object
        - `views` integer
        - `conversions` integer
        - `completions` integer
        - `submissions` integer
        - `subscribes` integer
        - `orders` integer
        - `bookings` integer
        - `custom_goals` integer
        - `revenue` number
        - `conversion_rate` number
        - `completion_rate` number
        - `subscribe_rate` number
        - `order_rate` number
        - `booking_rate` number
        - `custom_goal_rate` number
        - `aov` number
        - `previous` object
          - `views` integer
          - `conversions` integer
          - `completions` integer
          - `submissions` integer
          - `subscribes` integer
          - `orders` integer
          - `bookings` integer
          - `custom_goals` integer
          - `revenue` number
          - `conversion_rate` number
          - `completion_rate` number
          - `subscribe_rate` number
          - `order_rate` number
          - `booking_rate` number
          - `custom_goal_rate` number
          - `aov` number
        - `changes` object
          - `views` number
          - `conversions` number
          - `completions` unknown
          - `submissions` unknown
          - `subscribes` unknown
          - `orders` unknown
          - `bookings` unknown
          - `custom_goals` unknown
          - `revenue` unknown
          - `conversion_rate` number
          - `completion_rate` unknown
          - `subscribe_rate` unknown
          - `order_rate` unknown
          - `booking_rate` unknown
          - `custom_goal_rate` unknown
          - `aov` unknown

## Other responses

- `404`: campaign not found on this website
- `422`: validation error: invalid_timeframe, invalid_count_type, invalid_group_by or range_too_wide

---

[API](https://skmtc.dev/convertflow/apis/convertflow-api.md) - [All operations](https://skmtc.dev/convertflow/apis/convertflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/convertflow/apis/convertflow-api/revisions/9a45e0736b68?raw)