Routing and targeting
Platform, condition, target and feature (password, expiry, limit, UTM, delay) sub-resources.
Routes decide which visitor goes to which destination. Selection uses the targeting, deviceProfileIds, priority, sortOrder, isActive and isGlobalFallback fields.
Platform and conditions#
- platform:
GLOBAL,DEVICE,BROWSER,OS,GEO,LANGUAGE - condition type:
COUNTRY,DEVICE_PROFILE,OS,USER_AGENT,LANGUAGE,REFERRER_DOMAIN - operator:
IN,NOT_IN,EQUALS,REGEX - target: active platform catalog items; route targets are bound with
itemId
You can read the platform catalog with GET /api/v1/links/platform-catalog; the catalog is read-only in the public API.
Features#
Route feature types: PASSWORD, EXPIRATION_DATE, LIMIT, UTM and REDIRECT_DELAY. Features work at the link or route level and are managed with the enabled flag and a JSON config field.
Sub-resources#
| Method | Path | Scope |
|---|---|---|
| GET / POST | /api/v1/links/:id/routes | links:read / links:write |
| PATCH / DELETE | /api/v1/links/:id/routes/:routeId | links:write / links:delete |
| GET / POST | …/routes/:routeId/conditions | links:read / links:write |
| GET / POST | …/routes/:routeId/targets | links:read / links:write |
| GET / POST | …/routes/:routeId/features | links:read / links:write |
For every sub-resource, PATCH and DELETE are also supported on the …/:conditionId, …/:itemId and …/:featureId paths with the same scope rules.
Is something missing or wrong? Write to the support team; including the X-Request-Id value from the response speeds up the fix.