Home Insurance

Request for Server Side

🌐 Endpoint: https://api.myadoptimizer.com/api/MAOListingsServerAPI

⚙ HttpMethod: GET

📑 Response Format: JSON

🤖Try it out with swagger

---

Generic Query String Parameters

• LandingPageToken: This Token will be provided by your account manager

• Device: Desktop or Mobile. Some 3rd Party AdNetworks or Private Exchange Campaigns might require this value to be provided when using Server Side integration

• ClientIP: This is the user’s IP

• CurrentURL: Optional, the URL where listings will be displayed

• SourceID: Optional, tracking variable

• ExtClickID: Optional, tracking variable

Note

This tracking variables requires special integration. You need to append it to the destURL property from the results returned by API call.

• UserAgent: Optional, Mozilla/() ()
• CustomVar1: Optional, tracking variable (Max length - 75)
• CustomVar2: Optional, tracking variable (Max length - 75)
• CustomVar3: Optional, tracking variable (Max length - 75)
• CustomVar4: Optional, tracking variable (Max length - 75)
• CustomVar5: Optional, tracking variable (Max length - 75)

---

Specific Query String Parameters for Home Insurance

Query String Params Names	Data Type	Allowed Values
ZipCode	string	5 char US zip code
State*	string	2 char US state code (Uppercase)
Bathrooms	string	1, 2, 3, 4, 5+
Bedrooms	string	1, 2, 3, 4, 5+
CreditScore*	string	Excellent, Good, Fair, Poor
CurrentInsurer*	string	Allstate, Farmers, Nationwide, State Farm, USAA, American Family, Liberty Mutual, Travelers, Progressive, Other
CurrentlyInsured*	string	Yes, No
Gender*	string	Male, Female
HomeOwner*	string	Yes, No
Married*	string	Married, Single
MilitaryStatus*	string	Yes, No
PropertyStatus*	string	Primary Residence, Seasonal residence, Vacation Property, Rental Property
PropertyType*	string	Single Family, Multi Family, Mobile, Duplex, Condominium, Other
RecentClaims*	string	Yes, No
RoofType*	string	Asphalt Shingle, Wood Shingle, Tile Shingle, Metal, Other/Not Sure
SqFootage	Integer	Send the Sq Footage of the house
YearBuilt	Integer	Send the year house was built
MediaChannel	string	Social, Facebook, Native, Email, Display, SEM, SEO, SMS, Push, Affiliate, ChannelA, ChannelB, ChannelC, ChannelD, ChannelE
FName ±	string
LName ±	string
Email ±	string
Phone ±	string
Address ±	string
City ±	string

*Case Sensitive

±PII Fields

---

API Response

• destURL: This is the Click URL. Please use the value from this field when a click is triggered.

• impressionUrl: In the event that you are not planning to render all listings returned by this API you need to use this trigger. This is a call back URL to track live impressions. If a listing is displayed in your result set, please trigger the impressionUrl of that listing.

• displayUrl: This is the value from “Display URL” in the Campaign Ad Copy.

• trackingURL: This is a Image Pixel to track leads or form submits from Clicks. This is optional to implement, but it is used to provide traceability from a click to a lead submit.

• revenue: Actual payout per click based on bid modifiers.

• baseRevenue: Base bid per click. It’ll vary based on bid modifiers.

• bidModifierLog: The log that shows how the baseRevenue bid was modified.

• advertiserName: The name of the advertiser - The ID of the advertiser

• campaignPhoneNumber: New A unique phone number assigned to the campaign to track and measure calls.

• callToAction: New Text displayed on a clickable button or element, encouraging users to initiate a phone call.

• adResultCallStatusID: New An ID representing the campaign’s call status, where:

ID	Status	Allows calls
1	Click To Call is Active	TRUE
8	Campaign is out of schedule	FALSE
13	Click to Call Monthly Cap Reached	FALSE
14	Click to Call Daily Cap reached	FALSE
15	Click to Call is Off	FALSE
16	Campaign is off	FALSE

Note

When the campaign is inactive, the following message is broadcast: I’m sorry, but our campaign is currently inactive. Please try again later

Example response:

{
   "searchResultId": "e7eadf56-87b3-41a2-8c05-457523caf2a0",
   "duration": 869,
   "items": [
       {
           "itemId": "181",
           "brandName": "Provide Insurance",
           "networkSort": 1,
           "requestDuration": 666,
           "sourceID": null,
           "extClickID": null,
           "advertiserId": "111",
           "advertiserName": "Policy Genius - 128",
           "displayName": "Get Better Home Insurance Rates!",
           "headline": "Homeowners are shocked at this Genius Tip <br />Compare 3+ Rates at Once for Max Savings!<br />See if you Qualify for Lower Home Insurance<br />Save Today with a Fast Free Quote!",
           "blurbs": [
               "Homeowners are shocked at this Genius Tip ",
               "Compare 3+ Rates at Once for Max Savings!",
               "See if you Qualify for Lower Home Insurance",
               "Save Today with a Fast Free Quote!"
           ],
           "imageUrl": "https://cdn.myadoptimizer.com/maojsfiles/images/LogoAdvertiser_000000_fd8c4c64-6015-4720-91a8-9b359c754666.JPG",
           "destUrl": "https://api.myadoptimizer.com/api/MAOHttpRedirect?src=https://provide-homeowners-savings.com/&LandingPageID=20&EventID=e7eadf56-87b3-41a2-8c05-457523caf2a0&AdNetworkAPIID=23&cpc=9.75&Brand=Provide Insurance&Title=Get Better Home Insurance Rates!&CB=MxI+ul0svmqhIc6i55uEoA==&M=4XarSvqYDCayCqZpzLZFSg==&Weight=9.75&BidModifiers=50.00&NetworkAdID=181&SourceID=&LandingPageURL=" ,
           "displayURL": "ProvideHomeownersSavings.com/Quotes"
           "impressionUrl": "https://api.myadoptimizer.com/api/MAOSaveResults?LandingPageID=26&AdNetworkAPIID=29&EventID=ae9540ce-7f31-405e-b21c-f11e7a2168b8&AdCampaignID=311&RequestTypeID=4",
           "revenue": 9.75,
           "baseRevenue" : 6.50,
           "bidModifierLog": [
             "Consumer Credit: Good - Value: 50.00%",
             "States: CA - Value: -10.00%",
             "Tuesday: 14:18 - Value: 10.00%"
           ],
           "weight": 9.75,
           "statusId": 1,
           "trackingURL": "https://api.myadoptizer.com/api/MAOLeadTracking?AdNetworkAPIID=27&LandingPageID=24&EventID=8b448cc4-da0b-4f70-b180-c0c883282a49&IP=128.1.1.1&AdCampaignID=168",
           "campaignPhoneNumber": "+11234567890",
           "callToAction": "Call Now",
           "adResultCallStatusID": 1
       }
   ]
}

---

External Ad Networks Setup OPTIONAL

To integrate the following Ad Networks, MAO will need the following values.

Caution

Please provide YOUR publisher source values for each ad network below.

Media Alpha

• api_token
• placement_id

Transparent.ly

• pubcampaignId

Clicks.NET

• Affcamid
• Key

Quinstreet

• Src