TripConnect Campaign Data API

An API allowing a Partner to retrieve TripConnect campaign information from TripAdvisor.

The API response will provide details on instant booking campaigns, in addition to CPC campaigns.

Request

https://api.tripadvisor.com/api/partner_select/1.0/tripconnect_campaign?key=<partner_api_key>

ContentType: application/x-www-form-urlencoded

Parameters

NameTypeDescription
key string
The Connectivity Partner's key for this API.
tripadvisor_id number
Optional.
A particular TripAdvisor hotel ID on which to report.
Default to all.
partner_id string Optional.
A particular Connectivity Partner's hotel ID on which to report.
Default to all.

Response

ContentType: application/json

{
  "data": [
    {
      "partner_id": "26969",
      "tripadvisor_id": 72177,
      "ib": {
        "status": "ACTIVE",
        "since": "2015-03-05",
        "last_active": null
      },
"cpc": {
        "since": "2014-06-25",
        "platforms": ["desktop"],
        "last_active": "2015-01-08",
        "clicks": 391,
        "conversions": 0,
        "eligible": true
}
}, { "partner_id": "62745", "tripadvisor_id": 72388, "ib": { "status": "ACTIVE", "since": "2015-05-12", "last_active": null },
      "cpc": {
        "since": "2014-02-05",
        "platforms": ["desktop","mobile"],
        "last_active": "2015-08-01",
        "clicks": 193,
        "conversions": 104,
        "eligible": true
      }
 }, { "partner_id": "21565", "tripadvisor_id": 72932, "ib": { "status": "ACTIVE", "since": "2015-06-15", "last_active": null },       "cpc": {
        "since": "2015-01-15",
        "platforms": ["desktop","mobile"],
        "last_active": "2015-10-21",
        "clicks": 1273,
        "conversions": 842,
        "eligible": true
      }
} ], "paging": { "previous": null, "next": "https://api.tripadvisor.com/api/partner_select/1.0/tripconnect_campaign?offset=3&limit=3&key=ABCDtestkeyEFG", "skipped": "0", "results": "3", "total_results": "2081" } }

Properties

FieldTypeDescription
data array
An array of HotelCampaignData objects.
Each HotelCampaignData object contains information on instant booking or TripConnect CPC campaigns for the specified location.
paging object Information required to browse the next and previous sets of locations in the list, if they were not all returned as part of the current call.

HotelCampaignData
FieldTypeDescription
partner_id string
The Connectivity Partner's hotel ID
tripadvisor_id number
The TripAdvisor hotel ID
ib object
A HotelIBCampaign object.
An object containing details on the location's instant booking campaign.
If there is no campaign associated with this hotel, this field will be set to null.
cpc object
An object containing details on the location's TripConnect CPC campaign.
If there is no campaign associated with this hotel, this field will be set to null.

HotelIBCampaign
FieldTypeDescription
status string
Current instant booking campaign status for this property.
The value will be one of the following:
ACTIVE, INACTIVE, SUSPENDED, PAUSED
The values indicate the following states:
ACTIVE  :  The instant booking feature is available and functioning.
INACTIVE  :  The campaign is not active so the instant booking feature is not available or functioning. A new campaign will be required to have the instant booking feature available again.
SUSPENDED  :  The instant booking feature is available but functionality has been temporarily disabled (usually due to a transient payment issue).
PAUSED  :  The display of the instant booking feature has been temporarily disabled (usually done by the property owner) but the feature is still available and functional.
since string
The date that this property activated instant booking, if the property is using or has used instant booking.
last_active string
The date instant booking was last active for this property, if instant booking is no longer active. For example, if the property paused their campaign.
Otherwise this will be set to null.

HotelCPCCampaign
FieldTypeDescription
since string
The date that this property activated TripConnect CPC, if the property is using or has used TripConnect CPC.
platforms string
The list of platforms for which TripConnect CPC is currently active for this property (e.g. desktop, mobile)
last_active string
The date TripConnect CPC was last active for this property, if TripConnect CPC is no longer active. For example, if the property paused their campaign.
Otherwise this will be set to null.
clicks string
The number of TripConnect CPC clicks this property has received, if the property is using or has used TripConnect CPC. Otherwise this will be set to null.
conversions string
The number of bookings attributed to TripConnect CPC clicks that this property has received, if the property is using or has used TripConnect CPC and the Partner has implemented Conversion Tracking. Otherwise this will be set to null.
eligible string
For properties that have never used TripConnect CPC, this indicates whether this property is eligible to sign up. Range: true or false