Generate conversion analytics for selected QR Codes, with KPI, trend, event/site breakdown, and funnel outputs.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Comma-separated sections to return. Supported: count, trend, event_breakdown, site_breakdown, funnel, scan_overview, hybrid_funnel, 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. |
| Field | Type | Required | Description |
|---|---|---|---|
filter_by | string | Yes | One of: qrid, id, tags. |
q | array[string] | Yes | Values corresponding to filter_by. |
API key authentication. Enter your API key directly in the Authorization header.
Comma-separated analytics sections.
Start date (inclusive). Format: YYYY-MM-DD
End date (inclusive). Format: YYYY-MM-DD
Include all QRs in scope.
Search value used with all=true.
Comma-separated category slugs.
Comma-separated user IDs.
Comma-separated conversion event keys.
Ordered comma-separated funnel step event keys.
Conversion analytics generated successfully
The response is of type object.