Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Current »

Platform URL

https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/leads

API Endpoints

Epic

Document status

DRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Amish Ladhu

Related Content

Tracking Links

šŸ  Feature Overview

The ‘Tracking Information’ dialog provides publisher-specific tracking information such as tracking links, impression tags and API credentials.

The dialog can be accessed via Campaign > Publishers > ‘Actions’ column > ‘Tracking Information’ button:

Screenshot 2024-01-23 at 20.28.15.png

The newly opened dialog shows 3 tabs:

  • Tracking

  • Impression Tags

  • API Credentials


‘Tracking’ tab

The tracking links can capture publisher level performance statistics such as impressions, clicks, conversions, etc.

Each publisher tracking URL in the below table is automatically generated from the tracking links found in Campaign > Tracking > Links, and is unique for each publisher.

‘Name’ column format:

[Name of link setup in campaign > tracking > links] ([Channel name in campaign > tracking > links])

‘Link’ column url format:

https://ENTERPRISENAMEtrk.cvtr.io/click?lid=XXX?sid=?pid=XXXXX

  • sid - Optional sub ID that can be included as an additional identifier (a common use case could be including a campaign name as the sid to understand where each conversion came from, more detailed examples of usage can be found here)

  • lid - ID of tracking link (found on campaign > tracking > links > id column)

  • pid - ID of publisher (found on campaign > publisher > id column)

Screenshot 2024-01-23 at 20.38.43.png

Once generated, the publisher specific tracking URLs would be used on, for example, outbound links and buttons within an email creative or within publisher websites to track various statistics.

When each tracking link:

  • Tracking link is clicked - The clicks column will update

  • Destination URL is visited - Impressions column is updated

  • Form is completed (must be landing page which has a Convertr form) - Conversions column is updated

Screenshot 2024-01-23 at 20.58.40.png

‘Impression Tags’ tab

Impression tags allows reporting on the number of times this each pixel/tag has been displayed.

Each impression tag pixel in the below table is automatically generated from the tracking links found in Campaign > Tracking > Links, and is unique for each publisher.

‘Name’ column format:

[Name of link setup in campaign > tracking > links] ([Channel name in campaign > tracking > links])

‘Link’ column url format:

<img src="https://ENTERPRISENAME.cvtr.io/track/i?lid=XXX&pid=XXXXX" alt="" title="" width="1" height="1" />

  • lid - ID of tracking link (found on campaign > tracking > links > id column)

  • pid - ID of publisher (found on campaign > publisher > id column)

Screenshot 2024-01-23 at 21.16.50.png

Once generated, each tag/pixel requires manual implementation/adding into an assets code or in webpage code.

When a location that the impression tag/pixel has is been placed on is visited, the ‘impressions’ column on the publisher table will be updated.

Screenshot 2024-01-23 at 21.24.55.png

Unlike tracking links described above, there is no ‘destination URL’ required (which is setup in Campaign > Tracking > links) for the impression tag/pixel to direct the user to because this impression tag/pixel is placed on the destination itself.


‘API Credentials’ tab

API credentials provide access to Convertr’s REST API. It is currently mainly used send leads to the Convertr platform. Detailed documentation here.

Token Endpoint

Access token credentials for each publisher user.

Form Fields Endpoint

Used to retrieve all campaign forms with fields.

Campaign Links Endpoint

Used to retrieve all campaign links.

Post Lead Endpoint

Posts lead through a link and form.


\uD83D\uDDD2 Summary

Summarise the functionalities in a table

Functionality

User Story

1

Tracking

Used to capture publisher level performance statistics such as impressions, clicks, conversions, etc.

2

Impression Tags

Allows reporting on the number of times this each pixel/tag has been displayed.

3

API Credentials

Credentials provide access to Convertr’s REST API, mainly used send leads to the Convertr platform.


\uD83D\uDDD2 User Permissions

Mention if access needs to be enabled for any user roles and attach the user matrix.

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=415459484

  • No labels