9. Trackable Links
Content of this chapter
This chapter contains web service methods concerning trackable links of a mailing.
9.1. ListTrackableLinks
Namespace: http://agnitas.org/ws/schemas
Lists all trackable links of a mailing. The result contains condensed information on the link. The webservice can list links of mailings and mailing templates.
9.1.1. Request elements
| Element | Data type | Description |
|---|---|---|
| mailingID | {http://www.w3.org/2001/XMLSchema}int | ID of mailing to list links |
9.1.2. Response elements
| Element | Data type | Description |
|---|---|---|
| List of TrackableLink | One TrackableLink element per link (see below) | List of trackable links |
The list of trackable links can be empty!
Structure of an element for a trackable link:
| Elements | Data type | Description |
|---|---|---|
| urlID | {http://www.w3.org/2001/XMLSchema}int | ID of link |
| url | {http://www.w3.org/2001/XMLSchema}string | Currently used URL |
| shortname | {http://www.w3.org/2001/XMLSchema}string | Description to link |
| altText | {http://www.w3.org/2001/XMLSchema}string | Alternative text (Content of „alt“-attribute in HTML) |
| originalUrl | {http://www.w3.org/2001/XMLSchema}string | If the link URL has been edited afterwards, this is the original URL as found in the mailing |
9.1.3. SOAP Faults
The webservice returns a SOAP fault, if the mailing ID is unknown.
9.2. GetTrackableLinkSettings
Namespace: http://agnitas.org/ws/schemas
Returns the settings of a trackable link.
9.2.1. Request elements
| Element | Data type | Description |
|---|---|---|
| urlID | {http://www.w3.org/2001/XMLSchema}int | ID of links |
9.2.2. Response elements
| Elements | Data type | Description |
|---|---|---|
| urlID | {http://www.w3.org/2001/XMLSchema}int | ID of link |
| url | {http://www.w3.org/2001/XMLSchema}string | Current URL |
| actionID | {http://www.w3.org/2001/XMLSchema}int | ID of EMM action, that will be called of link click |
| shortname | {http://www.w3.org/2001/XMLSchema}string | Description of link |
| deepTracking | {http://www.w3.org/2001/XMLSchema}int | Settings of how the link tracking of website / in webshop is done |
| relevance | {http://www.w3.org/2001/XMLSchema}int | Set statistics, in which the link is listed. This property is not longer is use and returns 0. |
| altText | {http://www.w3.org/2001/XMLSchema}string | Alternative text (content of „alt“-attribute in HTML) |
| originalUrl | {http://www.w3.org/2001/XMLSchema}string | If the link URL has been edited afterwards, this is the original URL as found in the mailing |
| isAdminLink | {http://www.w3.org/2001/XMLSchema}boolean | Flag is link is an administrative link |
| linkExtensions | List with „linkExtension“ elements | List of URL extensions |
| tracking | {http://www.w3.org/2001/XMLSchema}int | Settings, in which mailing the link is tracked |
The values for „deepTracking“, „relevance“ and „tracking“ can be found in appendix A.
Structure of list elements „linkExtension“:
| Elements | Data type | Description |
|---|---|---|
| name | {http://www.w3.org/2001/XMLSchema}string | Name of URL parameter |
| value | {http://www.w3.org/2001/XMLSchema}string | Value of URL parameter |
9.2.3. SOAP Faults
The webservice returns a Soap Fault in case of an unknown link ID.
9.3. UpdateTrackableLinkSettings
Namespace: http://agnitas.org/ws/schemas
Updates the settings of a trackable link.
The only mandatory request element is „urlID“. All other elements (like „url“) are optional. The webservice updates only the settings, that are listed in the request.
9.3.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| urlID | {http://www.w3.org/2001/XMLSchema}int | ID of link |
| url | {http://www.w3.org/2001/XMLSchema}string | Current URL |
| actionID | {http://www.w3.org/2001/XMLSchema}int | ID of EMM action, that will be called of link click |
| shortname | {http://www.w3.org/2001/XMLSchema}string | Description of link |
| deepTracking | {http://www.w3.org/2001/XMLSchema}int | Settings of how the link tracking of website / in webshop is done |
| relevance | {http://www.w3.org/2001/XMLSchema}int | Set statistics, in which the link is listed. This property is not longer in use. Its settings will be ignored. |
| altText | {http://www.w3.org/2001/XMLSchema}string | Alternative text (content of „alt“-attribute in HTML) |
| originalUrl | {http://www.w3.org/2001/XMLSchema}string | If the link URL has been edited afterwards, this is the original URL as found in the mailing |
| isAdminLink | {http://www.w3.org/2001/XMLSchema}boolean | Flag is link is an administrative link |
| linkExtensions | List with „linkExtension“ elements | List of URL extensions |
| tracking | {http://www.w3.org/2001/XMLSchema}int | Settings, in which mailing the link is tracked |
The values for „deepTracking“, „relevance“ and „tracking“ can be found in appendix A.
Structure of list elements „linkExtension“:
| Elements | Data type | Description |
|---|---|---|
| name | {http://www.w3.org/2001/XMLSchema}string | Name of URL parameter |
| value | {http://www.w3.org/2001/XMLSchema}string | Value of URL parameter |
Optional elements:
| Elements | Default behavior, if not specified |
|---|---|
| url | Settings remains unchanged |
| actionID | Settings remains unchanged |
| shortname | Settings remains unchanged |
| deepTracking | Settings remains unchanged |
| relevance | Settings remains unchanged |
| altText | Settings remains unchanged |
| isAdminLink | Settings remains unchanged |
| linkExtensions | Settings remains unchanged |
| tracking | Settings remains unchanged |
9.3.2. Response elements
Note: The response has no elements.
9.3.3. SOAP Faults
A SOAP fault is returned in case of an error.
For unknown link Ids, the webservice returns a SOAP fault with appropriate error message.