Education
Server Side
Request for Server Side
š Endpoint: https://api.myadoptimizer.com/api/MAOListingsServerAPI
ā HttpMethod: GET
š Response Format: JSON
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 | |
|---|---|---|---|
| ZipCode | string | 5 char US zip code | |
| State* | string | 2 char US code (Uppercase) | |
| AdPlacement* | string | Program Listings - Widget, Program Listings - Static | |
| 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,Trades & Careers, Counseling, ANY | |
| Concentration* | string | Arts / Design / Fashion | Design & Visual Communications, Fashion/Apparel Design, Film and Theater, Graphic Design, Industrial Design, Interior Design, Photography, Visual Arts, ANY |
| Bootcamp | Data Analytics, Cyber Security, Coding, Software Engineering, General boot camp programs, Project Management, FinTech, Digital Marketing, UI-UX, Web Development, ANY | ||
| 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, ANY | ||
| 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, ANY | ||
| 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, ANY | ||
| Cosmetology & Beauty | Barbering/Barber, Cosmetology/Cosmetologist, Esthetician & Skin Care, Hair Styling & Hair Design, Make-Up Artist/Specialist, Manicurist/Nail Specialist, ANY | ||
| 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, ANY | ||
| Culinary Arts & Hospitality | Baking and Pastry Arts, Culinary Arts, Food Services, Hospitality Management, Restaurant & Food Services, Tourism & Travel Management, ANY | ||
| 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, ANY | ||
| General Studies / Undecided | General Studies, History, Liberal Arts, Undecided, Writing, ANY | ||
| 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
| ||
| Legal Professions | Court Reporting, Juris Doctor, Legal Administrative Assistant, Legal Assistant/Paralegal, Legal Studies, ANY | ||
| Massage Therapy & Healing Arts | Healing Arts & Alternative Medicine, Massage Therapy, ANY | ||
| Political Science | Political Science, ANY | ||
| 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, ANY | ||
| Religious Studies | Christian Studies, Ministry, Religious Studies, Theology, ANY | ||
| 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, ANY | ||
| Counseling | Addictions & Recovery, Counseling, Family Counseling, Mental Health Counseling, School Counseling, ANY | ||
| ANY | ANY | ||
| DegreeLevel* | string | CERTIFICATE, ASSOCIATES, BACHELORS, MASTERS, DOCTORATE, ANY | |
| LearningPreference* | string | CAMPUS, ONLINE, HYBRID | |
| Accreditations* | string | Regionally Accredited, Nationally Accredited, Cacrep Accredited, Mpcac Accredited, AACSB Accredited, AAPC Accredited, ABA Accredited, ABET Accredited, ABHES Accredited, ACBSP Accredited, ACCET Accredited, ACCJC Accredited, ACCSC Accredited, ACEN Accredited, ACEND Accredited, ACICS Accredited, ACOTE Accredited, ACPSP Accredited, AHIMA Accredited, APA Accredited, ARC-PA, Accredited ARRT Accredited, ASHA Accredited, CAAHEP Accredited, CAHIIM Accredited, CAHME Accredited, CCNE Accredited, CEPH Accredited, COAMFTE Accredited, COE Accredited, CSWE Accredited, DEAC Accredited, HLC Accredited, IACBE Accredited, Institutionally Accredited, MSCHE Accredited, NAACLS Accredited, NASAC Accredited, NASP Accredited, NASPAA Accredited, NAVTA Accredited, NEASC Accredited, NECHE Accredited, NLNAC Accredited, NWCCU Accredited, SACSCOC Accredited, SACSOC Accredited, WSCUC Accredited, CAEP Accredited, CACREP Adherence | |
| ProgramLength* | string | 1 Year Program, 2 Year Program, 18 Month Program, Accelerated, Advanced Standig Option | |
| ProgramRequirements* | string | NO GRE, NO GMAT, NO APPLICATION FEE | |
| 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.
-
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 |
Example response:
{ "searchResultId":"000xx000-00xx-0xx0-x0xx-000000x0000x", "duration":198, "items":[ { "itemId":"2196", "brandName":"Advertiser Brand 2022 09 19 13.06", "networkSort":1, "requestDuration":278, "sourceID":null, "extClickID":null, "advertiserId":"906", "advertiserName": "Advertiser Name 01 - 486", "displayName":"Campaign 2022 09 19 13.06", "adCopyVersion":1, "headline":"", "blurbs":[
], "programAdCopy":{ "customVar":[ { "element":"Institution", "items":[ { "item":"Public", "value":true } ] }, { "element":"Profit", "items":[ { "item":"Non-Profit", "value":true } ] }, { "element":"Enrollment", "items":[ { "item":"> 50K Students", "value":true } ] }, { "element":"Benefits", "items":[ { "item":"Flexible Schedules", "value":true } ] } ], "constraints":[ { "element":"Accreditations", "items":[ { "item":"Regionally Accredited", "value":true }, { "item":"Nationally Accredited", "value":true }, { "item":"CACREP Accredited", "value":true }, { "item":"MPCAC Accredited", "value":true }, { "item":"AACSB Accredited", "value":true }, { "item":"AAPC Accredited", "value":true }, { "item":"ABA Accredited", "value":true }, { "item":"ABET Accredited", "value":true }, { "item":"ABHES Accredited", "value":true }, { "item":"ACBSP Accredited", "value":true }, { "item":"ACCET Accredited", "value":true }, { "item":"ACCJC Accredited", "value":true }, { "item":"ACCSC Accredited", "value":true }, { "item":"ACEN Accredited", "value":true }, { "item":"ACEND Accredited", "value":true }, { "item":"ACICS Accredited", "value":true }, { "item":"ACOTE Accredited", "value":true }, { "item":"ACPSP Accredited", "value":true }, { "item":"AHIMA Accredited", "value":true }, { "item":"APA Accredited", "value":true }, { "item":"ARC-PA Accredited", "value":true }, { "item":"ARRT Accredited", "value":true }, { "item":"ASHA Accredited", "value":true }, { "item":"CAAHEP Accredited", "value":true }, { "item":"CAHIIM Accredited", "value":true }, { "item":"CAHME Accredited", "value":true }, { "item":"CCNE Accredited", "value":true }, { "item":"CEPH Accredited", "value":true }, { "item":"COAMFTE Accredited", "value":true }, { "item":"COE Accredited", "value":true }, { "item":"CSWE Accredited", "value":true }, { "item":"DEAC Accredited", "value":true }, { "item":"HLC Accredited", "value":true }, { "item":"IACBE Accredited", "value":true }, { "item":"Institutionally Accredited", "value":true }, { "item":"MSCHE Accredited", "value":true }, { "item":"NAACLS Accredited", "value":true }, { "item":"NASAC Accredited", "value":true }, { "item":"NASP Accredited", "value":true }, { "item":"NASPAA Accredited", "value":true }, { "item":"NAVTA Accredited", "value":true }, { "item":"NEASC Accredited", "value":true }, { "item":"NECHE Accredited", "value":true }, { "item":"NLNAC Accredited", "value":true }, { "item":"NWCCU Accredited", "value":true }, { "item":"SACSCOC Accredited", "value":true }, { "item":"SACSOC Accredited", "value":true }, { "item":"WSCUC Accredited", "value":true } ] }, { "element":"Program Requirements", "items":[ { "item":"NO APPLICATION FEE", "value":true }, { "item":"NO GRE", "value":true }, { "item":"NO GMAT", "value":true } ] }, { "element":"Program Length", "items":[ { "item":"1 Year Program", "value":true }, { "item":"2 Year Program", "value":true }, { "item":"18 Month Program", "value":true }, { "item":"Accelerated", "value":true }, { "item":"Advanced Standing Option", "value":true } ] } ], "location":"Location", "advertiserName":"Advertiser Name", "programName":"Program Name", "programDescription":"Program Description", "imageUrl":"https://cdn.myadoptimizer.com/maojsfiles/images/ProgramAdCopyLogo_000000_d000ac0d-a00f-000-0ba0-0a0b0yz00000.png" }, "imageUrl":"https://cdn.myadoptimizer.com/maojsfiles/images/", "destUrl":"https://maofunctionstest.azurewebsites.net/api/MAOHttpRedirect?src=Url+LInk&LandingPageID=64&EventID=000xx000-00xx-0xx0-x0xx-000000x0000x&AdNetworkAPIID=00&cpc=20.00&Brand=Advertiser Brand 2022 09 19 13.06&Title=&CB=abzOlnZByX2cFuqz9Mq5AQ==&M=4XarSvqYDCayCqZpzLZFSg==&Weight=20.00&BidModifiers=0&NetworkAdID=2196&SourceID=&LandingPageURL=&AdId=906&AdCopyVersion=1&CustomVar1=&CustomVar2=&CustomVar3=&CustomVar4=&CustomVar5=", "impressionUrl":"https://maofunctionstest.azurewebsites.net/api/MAOSaveResults?LandingPageID=00&AdNetworkAPIID=44&EventID=000xx000-00xx-0xx0-x0xx-000000x0000x&AdCampaignID=2196&RequestTypeID=4", "revenue":20.00, "cb":"abzOlnZByX2cFuqz9Mq5AQ==", "m":"4XarSvqYDCayCqZpzLZFSg==", "baseRevenue":20.00, "isOnlineSchool":false, "schoolAddress":"", "schoolCity":"", "schoolState":"", "schoolZipCode":"", "bidModifierLog":[
], "bidModifierPercentange":null, "weight":20.00, "statusId":1, "trackingURL":"https://maofunctionstest.azurewebsites.net/api/MAOLeadTracking?AdNetworkAPIID=44&LandingPageID=64&EventID=000xx000-00xx-0xx0-x0xx-000000x0000x&IP=50.162.168.1&AdCampaignID=2196", "displayUrl":"", "network":"MyAdOptimizer", "extSearchID":null, "customVar1":"", "customVar2":"", "customVar3":"", "customVar4":"", "customVar5":"", "campaignPhoneNumber": "+11234567890", "callToAction": "Call Now", "adResultCallStatusID": 1 } ]}Program Ad Copy
Response example for campaigns with program ad copy configured:
"programAdCopy": { "customVar": [ { "element": "Institution", "items": [ { "item": "Public", "value": true } ] }, { "element": "Profit", "items": [ { "item": "Non-Profit", "value": true } ] }, { "element": "Enrollment", "items": [ { "item": "> 50K Students", "value": true } ] }, { "element": "Benefits", "items": [ { "item": "Flexible Schedules", "value": true } ] } ], "constraints": [ { "element": "Accreditations", "items": [ { "item": "Regionally Accredited", "value": true }, { "item": "Nationally Accredited", "value": true }, { "item": "CACREP Accredited", "value": true }, { "item": "MPCAC Accredited", "value": true }, { "item": "AACSB Accredited", "value": true }, { "item": "AAPC Accredited", "value": true }, { "item": "ABA Accredited", "value": true }, { "item": "ABET Accredited", "value": true }, { "item": "ABHES Accredited", "value": true }, { "item": "ACBSP Accredited", "value": true }, { "item": "ACCET Accredited", "value": true }, { "item": "ACCJC Accredited", "value": true }, { "item": "ACCSC Accredited", "value": true }, { "item": "ACEN Accredited", "value": true }, { "item": "ACEND Accredited", "value": true }, { "item": "ACICS Accredited", "value": true }, { "item": "ACOTE Accredited", "value": true }, { "item": "ACPSP Accredited", "value": true }, { "item": "AHIMA Accredited", "value": true }, { "item": "APA Accredited", "value": true }, { "item": "ARC-PA Accredited", "value": true }, { "item": "ARRT Accredited", "value": true }, { "item": "ASHA Accredited", "value": true }, { "item": "CAAHEP Accredited", "value": true }, { "item": "CAHIIM Accredited", "value": true }, { "item": "CAHME Accredited", "value": true }, { "item": "CCNE Accredited", "value": true }, { "item": "CEPH Accredited", "value": true }, { "item": "COAMFTE Accredited", "value": true }, { "item": "COE Accredited", "value": true }, { "item": "CSWE Accredited", "value": true }, { "item": "DEAC Accredited", "value": true }, { "item": "HLC Accredited", "value": true }, { "item": "IACBE Accredited", "value": true }, { "item": "Institutionally Accredited", "value": true }, { "item": "MSCHE Accredited", "value": true }, { "item": "NAACLS Accredited", "value": true }, { "item": "NASAC Accredited", "value": true }, { "item": "NASP Accredited", "value": true }, { "item": "NASPAA Accredited", "value": true }, { "item": "NAVTA Accredited", "value": true }, { "item": "NEASC Accredited", "value": true }, { "item": "NECHE Accredited", "value": true }, { "item": "NLNAC Accredited", "value": true }, { "item": "NWCCU Accredited", "value": true }, { "item": "SACSCOC Accredited", "value": true }, { "item": "SACSOC Accredited", "value": true }, { "item": "WSCUC Accredited", "value": true } ] }, { "element": "Program Requirements", "items": [ { "item": "NO APPLICATION FEE", "value": true }, { "item": "NO GRE", "value": true }, { "item": "NO GMAT", "value": true } ] }, { "element": "Program Length", "items": [ { "item": "1 Year Program", "value": true }, { "item": "2 Year Program", "value": true }, { "item": "18 Month Program", "value": true }, { "item": "Accelerated", "value": true }, { "item": "Advanced Standing Option", "value": true } ] } ], "location": "Location", "advertiserName": "Advertiser Name", "programName": "Program Name", "programDescription": "Program Description", "imageUrl": "https://cdn.myadoptimizer.com/maojsfiles/images/ProgramAdCopyLogo_000000_d000ac0d-a00f-000-0ba0-0a0b0yz00000.png"}Response example for campaigns with program ad copy not configured:
"programAdCopy": { "customVar": [ null, null, null ], "constraints": [], "location": "", "advertiserName": "", "programName": "", "programDescription": "", "imageUrl": "" },External Ad Networks Setup Optional
To integrate the following Ad Networks, MAO will need the following values.
Media Alpha
api_tokenplacement_id
Transparent.ly
pubcampaignId
Clicks.NET
AffcamidKey
Quinstreet
Src