Conversion Rate by Dimension

get

https://www.pelcro.com/api/v1/core/analytics/customers/activity/conversion-by-dimension

Conversions and conversion rate for an event, grouped by a dimension.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

For each value of the chosen dimension, returns the number of conversion events (conversions, numerator), the number of base events (base, denominator — defaults to Page Viewed), and conversion_rate = conversions / base × 100.

conversion_rate is null when a bucket has zero base events.
A rate can exceed 100% when a bucket records more conversions than base events.
Results are ordered by conversions, highest first.
Pass user_id to scope to a single customer belonging to the site.

Use it for "which country/platform/channel converts best?"

Query Params

site_id

integer

required

The site ID to scope this request to.

conversion_event

string

required

The conversion event to attribute. Common values: "Subscription Created", "Registered", "Newsletter Email Submitted", "Invoice Paid". The valid set is per-site; an unrecognized value returns a 400 listing the events this site has recorded.

base_event

string

The base/traffic event used as the denominator. Defaults to "Page Viewed". The valid set is per-site; an unrecognized value returns a 400 listing the events this site has recorded.

dimension

string

enum

required

The dimension to group by.

Allowed:

user_id

integer

≥ 1

Scope the result to a single customer belonging to the site. Returns 404 if the customer is not on this site.

from

date

Start of the window in YYYY-MM-DD. Use with to. When omitted, a trailing default window is used. The from–to span is capped at the site’s activity retention window (90 days by default).

date

End of the window in YYYY-MM-DD. Must be on or after from and no later than today.

days

integer

1 to 90

Alternative to from/to: size of the trailing window in days (1–90). Bounded by the site’s activity retention window.

limit

integer

1 to 100

Maximum number of dimension buckets to return (1–100, default 10).

Responses

200Success.

400Invalid request — a parameter failed validation (unknown event name or dimension, malformed date, out-of-range limit, etc.).

401Unauthenticated.