📘
Convert is a versatile software tool designed for businesses to optimize their digital marketing efforts. It offers a suite of features including A/B testing, split URL testing, and multivariate testing to improve website performance and conversion rates. Convert provides intuitive, user-friendly interfaces for setting up experiments, tracking results, and making data-driven decisions, helping businesses to refine their online strategies and maximize conversions effectively.
Product Type: Analytics
Integration Type: Starter Kit & ID Sync
Event Source Type: Web
Event Scope: Full-Funnel Events
- Streams server-side event data into Convert for experiment tracking and measurement.
- Unlocks all customer data events and attributes for custom event mapping and transformation.
- Has no effect on website load latency.
- Supports full-funnel events including page, product, cart, and order lifecycle actions.
- The account ID and project ID are available in your Convert account URL.
- Each event's
ev output specifies the Convert event type(s) to send. By default most events send hitGoal; order_completed sends both hitGoal and tr (transaction). To change which types are sent for an event, modify eventTypes in that event's mapping (e.g., {"hitGoal"} for just hitGoal, or {"hitGoal", "tr"} for both).
- Transaction (
tr) events include the order revenue (r) and ordered product count (prc).
- Events are only sent when the
conv_v value is present; events without it are filtered out.
- Screen events are not supported and are filtered out.
- Captures the
conv_v value used for session identification and experiment bucketing.
- Required by Convert to associate events with a user's session, variations, and segments.
- Without this sync, events may not be accepted as valid by the integration.
- To collect the sync values (e.g.,
conv_v), you must implement a Convert ID sync. Refer to the following documentation to complete the setup: Convert - ID Sync Guide.
- Gather the following IDs from your Convert account:
- Account ID: Found in your Convert account URL (e.g.,
app.convert.com/accounts/XXXXXXXX/).
- Project ID: Found in the project list on the homepage, or in the URL once you click into a project (e.g.,
app.convert.com/accounts/XXXXXXXX/projects/XXXXXXXX).
- From the integration library, add a Convert integration. Then, fill out the Connection Parameters:
| Connection Parameter | Description |
|---|
PROJECT_ID | The project ID. |
ACCOUNT_ID | The account ID. |
- MetaRouter provides all of the event mappings that Convert integrations typically require. You may add custom events, parameters, or mappings in accordance with Convert's API documentation.
- In the Pipelines tab, add your Convert integration.
- Select the correct integration revision.
- Click Add Integration to finalize deployment.
Global mappings will be applied to all events. If your parameter names do not match the Expected Inputs provided, you will need to overwrite the Inputs provided with your own.
| Output Key | Description | Expected Input |
|---|
cid Required | String: Account ID. | $$ACCOUNT_ID$$ |
pid Required | String: Project ID. | $$PROJECT_ID$$ |
tid Required | String: Transaction ID, used for deduplication. | messageId |
seg.browser | String: Browser derived from user agent. One of IE, CH, FF, OP, SF, OTH. | Expression – derives the browser code from context.userAgent |
seg.devices | String: Device, one or more of DESK, OTHDEV, IPAD, ALLTAB, OTHTAB, OTHPH, IPH, ALLPH. | Expression – derives device from context.device.type |
seg.source | String: One of direct, referral, Search, Campaign. | Expression – returns the traffic source |
seg.new | Boolean: 0 if a new visitor in this session, 1 if returning. | Expression – derived from conv_v page views |
seg.ctry | String: Two-letter ISO country code. | Expression – converts context.location.country to ISO code |
seg.cust | String: Array of custom audience IDs set up in the project as segments. | Expression – parsed from conv_v segments |
vid Required | String: Session ID. | messageId |
Every event maps the ev output using the same expression; order_completed is the only event that sends a transaction (tr) in addition to hitGoal.
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal), goals, variation IDs (vars), and experience IDs (exps). | Expression – builds the event array from conv_v |
| Output Key | Description | Expected Input |
|---|
ev | Array: Builds the list of Convert events to send — for each experiment the user was bucketed into, an entry with the event type (hitGoal and tr), goals, variation IDs (vars), and experience IDs (exps). Transaction entries also include order revenue (r) and ordered product count (prc). | Expression – builds the event array from conv_v, including transaction data |
These identifiers must be mapped to Convert in order for successful user matching to occur. Without these IDs, any events sent to Convert will be rejected. For your convenience, required and recommended IDs are mapped as Global parameters to ensure they are added to every event.
| Attribute | Example | Sync Injector Required? |
|---|
vid Required | 1588166554499-0.2020703998482254 | Yes |
seg.browser Recommended | CH | No |
seg.devices Recommended | DESK | No |
seg.source Recommended | direct | No |
seg.new Recommended | 1 | No |
seg.ctry Recommended | RO | No |
seg.cust Recommended | 123 | No |
Coordinate with your Convert representative to confirm that events are being received and processed correctly on their backend.