Skip to main content
POST
/
analytics
/
ct
Get Conversion Tracking Analytics
curl --request POST \
  --url https://management.scanova.io/analytics/ct/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter_by": "qrid",
  "q": [
    "Q20a18d4af3e947a1"
  ]
}
'
{
  "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
      }
    ]
  },
  "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
  }
}

Query Parameters

ParameterTypeRequiredDescription
typestringYesComma-separated sections to return. Supported: count, trend, event_breakdown, site_breakdown, funnel, scan_overview, hybrid_funnel, raw.
fromstring (YYYY-MM-DD)YesInclusive start date.
tostring (YYYY-MM-DD)YesInclusive end date.
allbooleanNoInclude all QR Codes in scope.
searchstringNoSearch value used with all=true.
categorystringNoComma-separated category slugs.
usersstringNoComma-separated user IDs.
conversion_eventsstringNoComma-separated conversion event keys. Default: purchase,signup,lead,conversion.
funnel_stepsstringNoOrdered comma-separated event keys for funnel calculation.

Request Body

FieldTypeRequiredDescription
filter_bystringYesOne of: qrid, id, tags.
qarray[string]YesValues corresponding to filter_by.

Example Request

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

{
  "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
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Enter your API key directly in the Authorization header.

Query Parameters

type
string
required

Comma-separated analytics sections.

from
string<date>
required

Start date (inclusive). Format: YYYY-MM-DD

to
string<date>
required

End date (inclusive). Format: YYYY-MM-DD

all
boolean

Include all QRs in scope.

Search value used with all=true.

category
string

Comma-separated category slugs.

users
string

Comma-separated user IDs.

conversion_events
string

Comma-separated conversion event keys.

funnel_steps
string

Ordered comma-separated funnel step event keys.

Body

application/json
filter_by
enum<string>
required
Available options:
qrid,
id,
tags
Example:

"qrid"

q
string[]
required
Example:
["Q20a18d4af3e947a1"]

Response

200 - application/json

Conversion analytics generated successfully

The response is of type object.