| Page Properties | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
🏠 Feature Overview
Provide an overview of the feature and describe:
users who can access the page on the platform
widgets available to the users
functionalities available: Listing page, add, edit, delete, download etc. with screenshots
for add/create modals, provide details of the fields to be submitted to complete the action
E.g.
...
Name
...
Required
...
Notes
search and filter options available on table columns, if any
custom table views, pagination, if available
\uD83D\uDDD2 Summary
Summarise the functionalities in a table
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:
...
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)
...
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
...
‘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)
...
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.
...
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
Functionality | User Story | |||||
|---|---|---|---|---|---|---|
| 1 | 2 | 3 | 4 | 5 | 6 | 7 |
| 8 | Table Filtering | Allows the user to filer the table values using Advertiser Id, Advertiser Name, Campaign Id, Campaign Name and Label | ||||
| 9 | Custom Tables | A user can add, remove and reset columns for custom tableTracking | 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 matrixOnly admin and agency users have access to this section.