Skip to main content
POST
Get Conversion Tracking Analytics

Query Parameters

ParameterTypeRequiredDescription
typestringYesComma-separated sections to return. Supported: count, trend, event_breakdown, site_breakdown, funnel, scan_overview, hybrid_funnel, summary, traffic, audience, behavior, qr_performance, 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

Example Response

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:

Response

200 - application/json

Conversion analytics generated successfully

The response is of type object.