LinkSend
The LinkSend
object provides information about a link in a send, such as the URL and the number of clicks.
The LinkSend
object has the properties described in this table.
Name | DataType | Description |
---|---|---|
Client.ID | Int32 | The member ID (MID) of the account that the send was created in. |
Client.PartnerClientKey | String | The partner client key for the account. |
CorrelationID | String | Identifies correlation of objects across several requests. |
CreatedDate | DateTime | The date and time when the object was created. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
ID | Int32 | The unique ID of the LinkSend object. |
IDLong | Int64 | A long integer version of the ID. |
IsPlatformObject | Boolean | Not used with this object. |
Link.Alias | String | The clickable text for the link. |
Link.ID | Int64 | A unique identifier for the link. |
Link.PartnerKey | String | The partner key for the link. |
Link.TotalClicks | Int64 | The total number of clicks on the link. |
Link.UniqueClicks | Int64 | The number of unique clicks on the link. |
Link.URL | String | The URL of the link. |
ModifiedDate | DateTime | The date and time when the object was last modified. |
ObjectID | String | Not used with this object. |
ObjectState | String | Not used with this object. |
Owner | Owner object | An object that describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey | String | A unique identifier provided by partner for an object. |
PartnerProperties | Array of APIProperty[] objects | A collection of metadata related to the object. |
SendID | Int32 | The unique ID of the send that contains the link. |
This code example shows how to use the Describe
method to retrieve the properties of the LinkSend
object.
The response lists the properties of the object. For each property, the response indicates:
- The name of the property
- The data type of the property
- Whether the property can be updated (
IsUpdatable
) - Whether the property can be retrieved by using the
Retrieve
method (IsRetrievable
)