---
title: "Click report — scans reported apart from clicks"
method: GET
path: "/api/v1/analytics/report"
tags: ["analytics"]
---

# Click report — scans reported apart from clicks

`GET /api/v1/analytics/report`

## Request

- Base URL: `https://app.utmkit.co`
- URL: `https://app.utmkit.co/api/v1/analytics/report`
- Auth: HTTP bearer

Requires a token with the `analytics:read` permission.

## Query parameters

- `from` string, date
- `to` string, date
- `group_by` 'day' | 'country' | 'device' | 'referrer' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'utm_term' | 'utm_content' | 'trigger' | 'event_type' | 'destination'
- `short_code` string
- `host` string
- `campaign_id` integer
- `tag` string
- `compare` boolean

## Response `200`

Report

- Report
  - `capped` boolean
  - `comparison` object: Present only when compare=true: the previous period, or {unavailable: sentence}
    - `change` object
      - `clicks` integer, nullable
      - `conversions` integer, nullable
      - `scans` integer, nullable
      - `uniques` integer, nullable
    - `from` string, date
    - `to` string, date
    - `totals` object
      - `clicks` integer
      - `conversions` integer
      - `scans` integer
      - `uniques` integer
    - `unavailable` string
  - `from` string, date
  - `group_by` string
  - `rows` object[]
  - `to` string, date
  - `totals` object
    - `clicks` integer
    - `conversions` integer
    - `scans` integer
    - `uniques` integer
    - `value` object, nullable: currency → decimal string, summed per currency; null when no conversion in the period carried a value. Never summed across currencies (spec 046)

## Other responses

- `422`: Error

---

[API](https://skmtc.dev/utmkit/apis/utmkit-api.md) · [All operations](https://skmtc.dev/utmkit/apis/utmkit-api/llms.txt) · [OpenAPI document](https://skmtc.dev/utmkit/apis/utmkit-api/revisions/74266a7b244a?raw)