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

# Conversion Analytics

> Generate conversion analytics for selected QR Codes, with KPI, trend, event/site breakdown, and funnel outputs.

## Query Parameters

| Parameter           | Type                  | Required | Description                                                                                                                                                                                                              |
| :------------------ | :-------------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`              | `string`              | Yes      | Comma-separated sections to return. Supported: `count`, `trend`, `event_breakdown`, `site_breakdown`, `funnel`, `scan_overview`, `hybrid_funnel`, `summary`, `traffic`, `audience`, `behavior`, `qr_performance`, `raw`. |
| `from`              | `string (YYYY-MM-DD)` | Yes      | Inclusive start date.                                                                                                                                                                                                    |
| `to`                | `string (YYYY-MM-DD)` | Yes      | Inclusive end date.                                                                                                                                                                                                      |
| `all`               | `boolean`             | No       | Include all QR Codes in scope.                                                                                                                                                                                           |
| `search`            | `string`              | No       | Search value used with `all=true`.                                                                                                                                                                                       |
| `category`          | `string`              | No       | Comma-separated category slugs.                                                                                                                                                                                          |
| `users`             | `string`              | No       | Comma-separated user IDs.                                                                                                                                                                                                |
| `conversion_events` | `string`              | No       | Comma-separated conversion event keys. Default: `purchase,signup,lead,conversion`.                                                                                                                                       |
| `funnel_steps`      | `string`              | No       | Ordered comma-separated event keys for funnel calculation.                                                                                                                                                               |

## Request Body

| Field       | Type            | Required | Description                          |
| :---------- | :-------------- | :------- | :----------------------------------- |
| `filter_by` | `string`        | Yes      | One of: `qrid`, `id`, `tags`.        |
| `q`         | `array[string]` | Yes      | Values corresponding to `filter_by`. |

## Example Request

```bash theme={null}
curl -X POST "https://management.scanova.io/analytics/ct/?type=count,trend,event_breakdown,site_breakdown,funnel&from=2026-03-03&to=2026-03-10&search=trac&conversion_events=purchase,signup,lead,conversion&funnel_steps=pageview,click,purchase" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter_by": "qrid",
    "q": ["Q20a18d4af3e947a1"]
  }'
```

## Example Response

```json theme={null}
{
  "conversion": {
    "meta": {
      "warnings": [],
      "unlinked_qrs": []
    },
    "count": {
      "total_events": 12,
      "total_conversions": 12,
      "unique_sessions": 2,
      "conversion_rate": 600.0,
      "revenue": 0.0,
      "primary_currency": null,
      "currency_warning": null,
      "period": {
        "start": "2026-02-08",
        "end": "2026-03-10"
      }
    },
    "trend": [
      {
        "date": "2026-02-26",
        "unique_sessions": 1,
        "conversions": 7,
        "events": 7,
        "conversion_rate": 700.0
      },
      {
        "date": "2026-03-02",
        "unique_sessions": 1,
        "conversions": 5,
        "events": 5,
        "conversion_rate": 500.0
      }
    ],
    "event_breakdown": [
      {
        "event": "scroll",
        "total_events": 7,
        "unique_sessions": 2,
        "conversions": 7
      },
      {
        "event": "click",
        "total_events": 3,
        "unique_sessions": 1,
        "conversions": 3
      },
      {
        "event": "pageview",
        "total_events": 2,
        "unique_sessions": 2,
        "conversions": 2
      }
    ],
    "site_breakdown": [
      {
        "site": {
          "site_id": "pID5CJUPr6VgP53FJLCeNZpk9tQwQi0JpPmECQoxAEeTzrtzoQxCOAkSxrCQb3c4",
          "name": "Sample Site 1"
        },
        "total_events": 12,
        "unique_sessions": 2,
        "conversions": 12,
        "conversion_rate": 600.0
      }
    ],
    "funnel": [
      {
        "step": "pageview",
        "sessions": 2,
        "drop_off_percent": 0
      },
      {
        "step": "click",
        "sessions": 1,
        "drop_off_percent": 50.0
      },
      {
        "step": "scroll",
        "sessions": 1,
        "drop_off_percent": 0.0
      }
    ],
    "hybrid_funnel": [
      {
        "step": "scan",
        "sessions": 17,
        "drop_off_percent": 0
      },
      {
        "step": "pageview",
        "sessions": 2,
        "drop_off_percent": 88.24
      },
      {
        "step": "click",
        "sessions": 1,
        "drop_off_percent": 50.0
      },
      {
        "step": "scroll",
        "sessions": 1,
        "drop_off_percent": 0.0
      }
    ]
  },
  "scan_overview": {
    "total": 17,
    "elevation": {
      "percent": 100,
      "previous": 0,
      "type": "+",
      "period": {
        "start": "2026-01-08T18:07:00Z",
        "end": "2026-02-07T18:07:00Z"
      }
    },
    "unique": 2,
    "unique_elevation": {
      "percent": 100,
      "previous": 0,
      "type": "+",
      "period": {
        "start": "2026-01-08T18:07:00Z",
        "end": "2026-02-07T18:07:00Z"
      }
    },
    "scan_qr": 0,
    "scan_url": 17
  }
}
```


## OpenAPI

````yaml POST /analytics/ct/
openapi: 3.0.0
info:
  title: Scanova API - Analytics
  description: >-
    Analytics endpoints for retrieving QR code scan data, statistics, and
    exporting analytics reports. These endpoints provide comprehensive insights
    into QR code performance, user behavior, and geographic distribution.
  version: 1.0.0
servers:
  - url: https://management.scanova.io
    description: Scanova Management API Server
security:
  - apiKeyAuth: []
paths:
  /analytics/ct/:
    post:
      tags:
        - Analytics
      summary: Get Conversion Tracking Analytics
      description: >-
        Generate conversion analytics for selected QR codes, including default
        dashboard blocks, event/site/QR breakdown, and funnels.
      parameters:
        - name: type
          in: query
          required: true
          description: Comma-separated analytics sections.
          schema:
            type: string
          example: >-
            count,trend,event_breakdown,site_breakdown,funnel,scan_overview,hybrid_funnel,summary,traffic,audience,behavior,qr_performance
        - name: from
          in: query
          required: true
          description: 'Start date (inclusive). Format: YYYY-MM-DD'
          schema:
            type: string
            format: date
          example: '2026-03-03'
        - name: to
          in: query
          required: true
          description: 'End date (inclusive). Format: YYYY-MM-DD'
          schema:
            type: string
            format: date
          example: '2026-03-10'
        - name: all
          in: query
          required: false
          schema:
            type: boolean
          description: Include all QRs in scope.
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Search value used with all=true.
        - name: category
          in: query
          required: false
          schema:
            type: string
          description: Comma-separated category slugs.
        - name: users
          in: query
          required: false
          schema:
            type: string
          description: Comma-separated user IDs.
        - name: conversion_events
          in: query
          required: false
          schema:
            type: string
          description: Comma-separated conversion event keys.
          example: purchase,signup,lead,conversion
        - name: funnel_steps
          in: query
          required: false
          schema:
            type: string
          description: Ordered comma-separated funnel step event keys.
          example: pageview,click,purchase
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - filter_by
                - q
              properties:
                filter_by:
                  type: string
                  enum:
                    - qrid
                    - id
                    - tags
                  example: qrid
                q:
                  type: array
                  items:
                    type: string
                  example:
                    - Q20a18d4af3e947a1
      responses:
        '200':
          description: Conversion analytics generated successfully
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              examples:
                conversion_analytics:
                  summary: Conversion analytics response
                  value:
                    conversion:
                      meta:
                        warnings: []
                        unlinked_qrs: []
                      count:
                        total_events: 12
                        total_conversions: 12
                        unique_sessions: 2
                        conversion_rate: 600
                        revenue: 0
                        primary_currency: null
                        currency_warning: null
                        period:
                          start: '2026-02-08'
                          end: '2026-03-10'
                      trend:
                        - date: '2026-02-26'
                          unique_sessions: 1
                          conversions: 7
                          events: 7
                          conversion_rate: 700
                        - date: '2026-03-02'
                          unique_sessions: 1
                          conversions: 5
                          events: 5
                          conversion_rate: 500
                      event_breakdown:
                        - event: scroll
                          total_events: 7
                          unique_sessions: 2
                          conversions: 7
                        - event: click
                          total_events: 3
                          unique_sessions: 1
                          conversions: 3
                        - event: pageview
                          total_events: 2
                          unique_sessions: 2
                          conversions: 2
                      site_breakdown:
                        - site:
                            site_id: >-
                              pID5CJUPr6VgP53FJLCeNZpk9tQwQi0JpPmECQoxAEeTzrtzoQxCOAkSxrCQb3c4
                            name: Sample Site 1
                          total_events: 12
                          unique_sessions: 2
                          conversions: 12
                          conversion_rate: 600
                      funnel:
                        - step: pageview
                          sessions: 2
                          drop_off_percent: 0
                        - step: click
                          sessions: 1
                          drop_off_percent: 50
                        - step: scroll
                          sessions: 1
                          drop_off_percent: 0
                      hybrid_funnel:
                        - step: scan
                          sessions: 17
                          drop_off_percent: 0
                        - step: pageview
                          sessions: 2
                          drop_off_percent: 88.24
                        - step: click
                          sessions: 1
                          drop_off_percent: 50
                        - step: scroll
                          sessions: 1
                          drop_off_percent: 0
                      summary:
                        visitors: 2
                        pageviews: 2
                        events: 12
                        conversions: 12
                        revenue: 0
                      traffic:
                        visitors_by_date:
                          - date: '2026-02-26'
                            visitors: 1
                          - date: '2026-03-02'
                            visitors: 1
                        top_pages: []
                      audience:
                        countries: []
                        devices: []
                        browsers: []
                      behavior:
                        top_events:
                          - event: scroll
                            total_events: 7
                            unique_sessions: 2
                            conversions: 7
                        event_timeline:
                          - date: '2026-02-26'
                            unique_sessions: 1
                            conversions: 7
                            events: 7
                            conversion_rate: 700
                      qr_performance:
                        - qrid: Q20a18d4af3e947a1
                          total_events: 12
                          unique_sessions: 2
                          conversions: 12
                          conversion_rate: 600
                          revenue: 0
                    scan_overview:
                      total: 17
                      elevation:
                        percent: 100
                        previous: 0
                        type: +
                        period:
                          start: '2026-01-08T18:07:00Z'
                          end: '2026-02-07T18:07:00Z'
                      unique: 2
                      unique_elevation:
                        percent: 100
                        previous: 0
                        type: +
                        period:
                          start: '2026-01-08T18:07:00Z'
                          end: '2026-02-07T18:07:00Z'
                      scan_qr: 0
                      scan_url: 17
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Enter your API key directly in the Authorization
        header.

````