Tracker Domain Object

Tracker domains give your visitors a seamless transition between your hosted pages and forms and your Account Engagement assets. Learn more about tracker domains in Salesforce Help.

The API to access the Tracker Domain object collection follows the conventions described in Version 5 Overview.

Include the authentication header with every request. For information on how to authenticate, see Authentication.

Note

Supported Operations

Operation	HTTP Verb	URL Format	Ability Requirements
Read	`GET`	`https://pi.pardot.com/api/v5/objects/tracker-domains/<id>?<params>`	Marketing > Content > Files > View ability OR Marketing > Content > Custom Redirects > View ability OR Marketing > Forms > Forms > View ability OR Marketing > Forms > Form Handlers > View ability OR Marketing > Landing Pages > Landing Pages > View ability
Query	`GET`	`https://pi.pardot.com/api/v5/objects/tracker-domains?<params>`	Marketing > Content > Files > View ability OR Marketing > Content > Custom Redirects > View ability OR Marketing > Forms > Forms > View ability OR Marketing > Forms > Form Handlers > View ability OR Marketing > Landing Pages > Landing Pages > View ability

Fields

Read-Only Fields

Field	Type	Description
`id`	Integer	ID of the object.
`domain`	String	Hostname to which links using this tracker domain are resolved.
`isPrimary`	Boolean	True if the tracker domain is primary tracker domain for the account. Only one tracker domain can be designated as the primary and must be unique across all Account Engagement accounts.
`isDeleted`	Boolean	True if the object is in the recycle bin in Account Engagement.
`defaultCampaignId`	Integer	The ID of the default campaign for this tracker domain.
`httpsStatus`	String	Identify if this tracker domain is using http or https.
`sslStatus`	String	Status of SSL for this vanity tracker domain.
`sslStatusDetails`	String	Extra information for the status of SSL for this vanity tracker domain.
`sslRequestedById`	Integer	ID of the User who manually requested enabling SSL for this tracker domain.
`validationStatus`	String	The status can be default, validated or not validated
`validatedAt`	DateTime	Time when this tracker domain validation became validated.
`vanityUrlStatus`	String	Indicates whether this tracker domain can serve vanity urls.
`trackingCode`	String	The tracking code for this object encoded as JSON string. A default campaign is required before generating tracking codes as well as enabling first party tracking in account settings. For more information read here
`createdAt`	DateTime	Creation time of the object.
`updatedAt`	DateTime	Last update time of the object.
`createdById`	Integer	ID of the user who created this object.
`updatedById`	Integer	ID of the user who last updated this object.
`createdBy`	User	User object representing the user who created this object. See documentation for User for fields.
`updatedBy`	User	User object representing the user who last updated this object. See documentation for User for fields.
`sslRequestedBy`	User	User object representing the User who manually requested enabling SSL for this tracker domain. See documentation for User for fields.
`defaultCampaign`	Campaign	Campaign object representing the default campaign for this tracker domain. See documentation for Campaign for fields.

Tracker Domain Read

Retrieve a single tracker domain object following the conventions described in the Version 5 Overview.

Example request:

1GET /api/v5/objects/tracker-domains/101?fields=id,domain,isPrimary,isDeleted
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example response:

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "id": 101,
5    "domain": "tracked.example.com",
6    "isPrimary": "true",
7    "isDeleted": "false"
8}

Tracker Domain Query

Retrieving a collection of tracker domains follows the conventions described in Version 5 Overview.

Sortable Fields

When executing a query, the following fields can be specified in the orderBy parameter. See the conventions for query described in the Version 5 Overview.

id

Example request:

1GET /api/v5/objects/tracker-domains?fields=id,domain,isPrimary,isDeleted&orderBy=id
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example response:

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "values": [
5        {
6            "id": 101,
7            "domain": "tracked.example.com",
8            "isPrimary": "true",
9            "isDeleted": "false"
10        }
11    ]
12}

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

Parameter	Description
`id`	Returns any tracker domains where ID is equal to the given integer value.
`idList`	Returns any tracker domains where ID is included in the given list of values.
`idGreaterThan`	Returns any tracker domains where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any tracker domains where ID is greater than or equal to the specified value.
`idLessThan`	Returns any tracker domains where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any tracker domains where ID is less than or equal to the specified value.
`deleted`	Determines whether to return deleted records. The value can be `false` (default), `true`, or `all`.

Example request:

1GET /api/v5/objects/tracker-domains?fields=id,domain&orderBy=id desc&idGreaterThan=200&idLessThan=300
2Host: pi.pardot.com
3Authorization: Bearer <access-token>

Example response:

1HTTP/1.1 200 OK
2Content-Type: application/json
3{
4    "values": [
5        {
6            "id": 282,
7            "domain": "flyers.example.com"
8        },
9        {
10            "id": 225,
11            "domain": "promotions.example.com"
12        },
13        {
14            "id": 207,
15            "domain": "tracked.example.com"
16        }
17    ]
18}