Top Referrers

get

https://www.pelcro.com/api/v1/core/analytics/customers/activity/top-referrers

Referrer domains driving a conversion event.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Ranks the referrer domains (page.referrer_domain) attached to a conversion event over the window.

Direct traffic (no referrer) is reported with the label (direct).
Each row's percentage is its share of the conversion event's total.
Pass user_id to scope to a single customer belonging to the site.

Use it for "which external sources drive the most subscriptions?"

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.

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 referrers to return (1–100, default 10).

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

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

401Unauthenticated.