Skip to content
MyAdOptimizer Instructions Doc's

Education

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 to be used at your convenience. MAO will track it and can be used for custom reporting

  • ExtClickID: Optional, tracking variable to be used at your convenience. MAO will track it and can be used for custom reporting

  • ExtSearchID: Optional, tracking variable to be used at your convenience. MAO will track it and can be used for custom reporting
  • 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 Education

Prams Name Data type Allowed Values
ZipCodestring 5 char US zip code
State*string 2 char US code (Uppercase)
AdPlacement*string

ICF, No Matches, After Matches, API, High School, Ad Unit, Organic Exit Pop, Paid Search Exit Pop

AreaOfStudy* String

Arts / Design / Fashion, Bootcamp, Business, Communication & Multimedia, Computers & IT, Cosmetology & Beauty, Criminal Justice & Law Enforcement, Culinary Arts & Hospitality, Education & Teaching, General Studies / Undecided, Health & Medical / Nursing, Legal Professions, Massage Therapy & Healing Arts, Political Science, Psychology & Social Work, Religious Studies, Sciences, Trades & Careers, Counseling

Concentration* string Arts / Design / Fashion

Design & Visual Communications, Fashion/Apparel Design, Film and Theater, Graphic Design, Industrial Design, Interior Design, Photography, Visual Arts

Bootcamp

Data Analytics, Cyber Security, Coding, Software Engineering, General boot camp programs, Project Management, FinTech, Digital Marketing, UI-UX, Web Development, Scrum Master, Cloud Developer

Business

Accounting & Related Services, Administrative & Secretarial Services, Business Communications, E-Commerce/Business, Economics, Entrepreneurship & Small Business, Fashion and Apparel, Finance, General Business, Green & Sustainable Management, Hospitality & Restaurants, Human Resources, Information Systems Management, International, Business, Management, Marketing, Property Management / Real Estate, Public & Non-Profit Administration, Public Relations, Retail & Sales, Supply Chain Management, Business Administration, Business Analytics, Business Intelligence, Organizational Leadership, Project Management, Taxation

Communication & Multimedia

Advertising, Animation & Video Graphics, Commercial & Advertising Art, Computer Media Applications, Design & Visual Communications, Film/Video & Cinematography, Graphic Design, Intermedia/Multimedia, Photography, Recording Arts Technology, Web Design

Computers & IT

Computer Science, Computer Support Services, Computer Systems Security, Networking, Software Development, Systems Administration, Telecommunications, Web Design and Internet, Analytics & Data Science, Engineering, Information & Library Sciences, Information Technology/Systems, Product Manager

Cosmetology & Beauty

Barbering/Barber, Cosmetology/Cosmetologist, Esthetician & Skin Care, Hair Styling & Hair Design, Make-Up Artist/Specialist, Manicurist/Nail Specialist

Criminal Justice & Law Enforcement

Correctional Officer (Prison Officer), Criminal Justice & Law Enforcement/Police, Fire Science, Forensics/Crime Scene Investigation, Homeland Security, Security Services, Criminal Justice, Criminology

Culinary Arts & Hospitality

Baking and Pastry Arts, Culinary Arts, Food Services, Hospitality Management, Restaurant & Food Services, Tourism & Travel Management

Education & Teaching

Administration & Leadership, Curriculum and Instruction, Early Childhood Education, Education and Teaching, General Education, Secondary Education, Educational Technology, Elementary Education, Music Education, Reading & Literacy, Special Education, Teaching

General Studies / Undecided

General Studies, History, Liberal Arts, Undecided, Writing, English, Foreign Languages, Sign Language, Philosophy

Health & Medical / Nursing

Alternative Medicine/Healing Arts, Bachelors of Nursing (BSN), Dental Assisting, Dental Hygienist, Diagnostic & Treatment Technician, General Nursing, Gerontology, Global Health, Health Information Technology/Records, Healthcare Administration, Human Services/Social Work, Medical Assistant, Medical Insurance Biller/Coder, Medical Office Assistant, Medical Transcriptionist, Nursing - DNP, Nursing - Licensed Practical/Vocational Nurse Training (Certificate), Nursing - MSN, Nursing - Registered Nurse (AAS), Nursing - RN to BSN, Nursing Assistant (CNA), Personal Training / Nutrition, Pharmacy Technician/Assistant, Phlebotomy / Clinical Medical Lab. Technician, Physical Therapy & Rehabilitation, Psychology, Surgical Technologist, Ultrasound Technician, Veterinary Medicine, X-Ray/Radiologic Technician, Emergency Management, Nurse Education, Nurse Practitioner (RN Required), Public Health, Speech Pathology/Therapy,Entry-Level Healthcare Programs, Telehealth, Optical, Pediatrics, Plastic Surgery, Toxicology / Pharmacology

Legal Professions

Court Reporting, Juris Doctor, Legal Administrative Assistant, Legal Assistant/Paralegal, Legal Studies

Massage Therapy & Healing ArtsHealing Arts & Alternative Medicine, Massage Therapy
Political SciencePolitical Science
Psychology & Social Work

Business & Organizational Psychology, Clinical Psychology, Counseling Psychology, Forensic Psychology/Crime Scene Investigator, General Psychology, Human Services/Social Work, Sport Psychology, Behavioral Psychology, Child Psychology, Educational Psychology

Religious StudiesChristian Studies, Ministry, Religious Studies, Theology
Sciences

Anthropology, Biochemistry, Biology, Botany / Horticulture, Chemistry, Environmental Science / Ecology, General Sciences, Genetics, Marine Biology, Mathematics, Neurology / Physiology, Physics, Planetary / Astrology, Research, Zoologist

Trades & Careers

Aircraft Maintenance, Auto Mechanic, Autobody Repair, Aviation, CAD Drafting and Design, Computer Installation & Repair, Computer Systems Technology, Construction Management, Electrician, Engineering Technology/Technicians, HVAC, Laboratory Technician, Plumbing Technology/Plumber, Telecommunications Technology, Truck Driving, Welding Technology/Welder

Counseling

Addictions & Recovery, Counseling, Family Counseling, Mental Health Counseling, School Counseling

DegreeLevel*stringCERTIFICATE, ASSOCIATES, BACHELORS, MASTERS, DOCTORATE
HighSchoolGradYearstring

2023+, 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012, 2011, 2010, 2009, 2008, 2007, 2006, 2005, 2004, 2003, 2002, 2001, 1990

HighestEducationLevel*string

STILL_IN_HIGH_SCHOOL, NO_HIGH_SCHOOL_OR_GED, HIGH_SCHOOL, SOME_COLLEGE, ASSOCIATES_DEGREE, BACHELORS_DEGREE, MASTERS_DEGREE, DOCTORAL_DEGREE, GED

LearningPreference*stringCAMPUS, ONLINE, HYBRID, ANY
LikelihoodToEnroll*stringNOT_LIKELY, SOMEWHAT_LIKELY, VERY_LIKELY
MediaChannel*string

Social, Facebook, Native, Email, Display, SEM, SEO, SMS, Push, Affiliate, ChannelA, ChannelB, ChannelC, ChannelD, ChannelE

MilitaryStatus*stringtrue, false, null
RNDegree*stringtrue, false, null
StartDate*string

LESS_THAN_1_MONTH, 1_TO_3_MONTHS, 3_TO_6_MONTHS, 6_TO_12_MONTHS, OVER_12_MONTHS

USCitizen*stringtrue, false, null
FName ±string
LName ±string
Email ±string
Phone ±string
Address ±string
City ±string

*Case Sensitive

** Program Ad Copy Allowed Values

±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:

IDStatusAllows calls
1Click To Call is ActiveTRUE
8Campaign is out of scheduleFALSE
13Click to Call Monthly Cap ReachedFALSE
14Click to Call Daily Cap reachedFALSE
15Click to Call is OffFALSE
16Campaign is offFALSE

Example response:

{
   "searchResultId":"acbb214a-e69e-4394-bea0-3b48f6997cca",
   "duration":446,
   "items":[
      {
         "itemId":"458",
         "brandName":"Florida Career College",
         "networkSort":1,
         "requestDuration":306,
         "sourceID":null,
         "extClickID":"testClickID",
         "advertiserId":"409",
         "advertiserName": "Advertiser Name 01 - 486",
         "displayName":"Earn A Business Office Administration Diploma - Start Building A Future You Can Be Proud Of",
         "adCopyVersion":1,
         "headline":"Learn valuable technical skills like - Microsoft Word®, Microsoft Excel®, Microsoft PowerPoint® and more!<br />Prepare for career opportunities like: Administrative Assistant, Secretary, Customer Service Rep, and more!<br />Fast: Prepare for a career in as few as 10 months<br />Convenient: Daytime and evening classes available",
         "blurbs":[
            "Learn valuable technical skills like - Microsoft Word®, Microsoft Excel®, Microsoft PowerPoint® and more!",
            "Prepare for career opportunities like: Administrative Assistant, Secretary, Customer Service Rep, and more!",
            "Fast: Prepare for a career in as few as 10 months",
            "Convenient: Daytime and evening classes available",
            "Helpful: Financial Aid available to those who qualify"
         ],
         "programAdCopy":{
            "customVar":[
               null,
               null,
               null
            ],
            "constraints":[


            ],
            "location":"",
            "advertiserName":"",
            "programName":"",
            "programDescription":"",
            "imageUrl":""
         },
         "imageUrl":"https://cdn.myadoptimizer.com/maojsfiles/images/LogoAdvertiser_000458_52ce13ea-5a04-42cc-8c44-919677e99f04.jpg",
         "destUrl":"https://api.myadoptimizer.com/api/MAOHttpRedirect?src=https%3A%2F%2Finfo.floridacareercollege.com%2Fbusiness-office-administration%2F%3Fadkey%3DIS1CAEXN00%26ctc%3D877-425-6149%26utm_source%3Dcexplorer%26utm_medium%3Dcpc%26utm_campaign060118-fcc-cpc%26utm_content%3DFCC-Business%26CCK%3Dacbb214a-e69e-4394-bea0-3b48f6997cca%7Cfcc_business%26t%3DtestClickID&LandingPageID=43&EventID=acbb214a-e69e-4394-bea0-3b48f6997cca&AdNetworkAPIID=44&cpc=34.50&Brand=Florida Career College&Title=Earn A Business Office Administration Diploma - Start Building A Future You Can Be Proud Of&CB=1VawjEjip8ij5oaSZJZ0mw==&M=4XarSvqYDCayCqZpzLZFSg==&Weight=34.50&BidModifiers=50.00&NetworkAdID=458&SourceID=&LandingPageURL=",
         "impressionUrl":"https://api.myadoptimizer.com/api/MAOSaveResults?LandingPageID=43&AdNetworkAPIID=44&EventID=acbb214a-e69e-4394-bea0-3b48f6997cca&AdCampaignID=458&RequestTypeID=4",
         "revenue":34.5,
         "baseRevenue":23.0,
         "isOnlineSchool":null,
         "schoolAddress":"",
         "schoolCity":"",
         "schoolState":"",
         "schoolZipCode":"",
         "bidModifierLog":[
            "Ad Placement: ICF - Value: 50.00%",
            "States: PA - Value: -10.00%",
            "Tuesday: 14:40 - Value: 10.00%"
         ],
         "weight":34.5,
         "statusId":1,
         "trackingURL":"https://api.myadoptimizer.com/api/MAOLeadTracking?AdNetworkAPIID=44&LandingPageID=43&EventID=acbb214a-e69e-4394-bea0-3b48f6997cca&IP=123.32.32.123&AdCampaignID=458",
         "displayUrl":"http://www.floridacareercollege.com/business-office-administration",
        "campaignPhoneNumber": "+11234567890",
        "callToAction": "Call Now",
        "adResultCallStatusID": 1
      }
   ]
}

External Ad Networks Setup Optional

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

Media Alpha

  • api_token
  • placement_id

Transparent.ly

  • pubcampaignId

Clicks.NET

  • Affcamid
  • Key

Quinstreet

  • Src