Export aggregated conversion analytics in CSV/XLS/XLSX formats.
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | No | Comma-separated sections. Typical: count,trend,event_breakdown,site_breakdown,funnel,scan_overview,hybrid_funnel. |
from | string (YYYY-MM-DD) | Yes | Inclusive start date. |
to | string (YYYY-MM-DD) | Yes | Inclusive end date. |
file_format | string | Yes | One of: csv, xls, xlsx. |
sheet | string | No | CSV-only selected sheet key. Examples: count, trend, event_breakdown, site_breakdown, funnel, hybrid_funnel, scan_overview. |
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. |
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.
csv, xls, xlsx CSV sheet key.
File generated successfully
The response is of type file.