Saved segments: named filter sets in the Pixel API

Create and use segments with the Pixel API

Segments live under /api/v1/pixel/segments and need an API key: pixel:read to list and apply them, pixel:write to create, rename and delete them. Each name is unique per website.

To use a segment, call POST /pixel/segments/{id}/apply. It returns the stored filters, which you pass as query parameters to any report endpoint. The full request and response shapes are in the Pixel API endpoints guide.

Filters a segment can hold

The report endpoints accept these filters, so these are the ones worth saving:

• country: Country (ISO-2 code, e.g. US)
• device: Device type (desktop / mobile / tablet)
• browser: Browser
• os: Operating system
• referrer: Referrer URL
• page: Page path (e.g. /pricing)
• utm_source: UTM source
• utm_medium: UTM medium
• utm_campaign: UTM campaign
• utm_term: UTM term
• utm_content: UTM content

On the dashboard today

The dashboard doesn't apply saved segments yet. To slice your data there:

• Pick the site, a date range (Today through All time, or Custom) and the chart granularity in the toolbar.
• Turn on compare to see each number against the previous period of the same length.
• The source, page, location, device and technology cards each break your traffic down by that dimension.
• A funnel can compare two utm_source values side by side, for example google and facebook.

Want segments on the dashboard?

Tell us how you'd use them at /support. Requests shape what we build next.

Related documentation

Pixel API endpoints · Conversion funnels · UTM best practices