Qodex.ai
Qodex.ai
Introduction
(Legacy) Ads Lead Generation
(Legacy) Use Cases-(Legacy) Push workflow
2. Retrieve the user's Ad Accounts (sponsoredAccount)4. Look up the ad accounts organization5. Validate user's organization role6. Retrieve Lead Gen Forms8. Retrieve past leads looking back 90 days9. Register for lead notifications11. Fetch full lead data after a notification is receivedDelete a registered webhook
(Legacy) Use Cases-(Legacy) Pull workflow
2. Retrieve the user's Ad Accounts (sponsoredAccount)4. Look up the ad accounts organization Copy5. Validate user's organization role Copy6. Retrieve Lead Gen Forms Copy9. Retrieve past leads looking back 90 days
(Legacy) Events Lead Generation
(Legacy) Use Cases-(Legacy) Pull Workflow
2. Get the user's organization(s) (company pages)4. Get user's events tied to the chosen organization6. Get Lead Gen Form tied to the user's Events9. Schedule periodic form response (lead) pulls
Audience Insights
Ad Targeting Entities
Get a list of available Ad Targeting FacetsGet Bing Geo locations using search typeahead
Fetch Audience Insights
What are the top interests of Directors in Finance and in the US?
Audiences
Use Cases-Streaming Companies - Account Targeting
2. Retrieve the user's Ad Accounts (sponsoredAccount)8. Monitor Status of the Company DMP Segments6. Create a Company DMP Segment7. Stream company data - add or remove multiple companies
Use Cases-Streaming Users - Contact Targeting
2. Retrieve the user's Ad Accounts (sponsoredAccount)8. Monitor Status of the User DMP Segments6. Create a User DMP segment (skip this step if the user chose to update an existing Audience)7. Stream user data - add or remove multiple users
Use Cases-CSV list upload - Account & Contact Targeting
2. Retrieve the user's Ad Accounts (sponsoredAccount)6. Create list upload DMP Segment7. Attach the Uploaded List to the List Upload DMP Segment8. Monitor Status of the List Upload DMP Segments
Campaign Management
Use Cases-Account structure-User Access
Create Ad Account UserFetch an Ad Account UserFetch the Authenticated User's Ad AccountsFetch the Authenticated User's Organization RolesUpdate Existing Ad Account UserDelete an Ad Account User
Use Cases-Account structure-Account Management
Create a Test Ad AccountFetch the Ad Account by IDSearch Account by TypeUpdate Ad Account Name
Use Cases-Account structure-Campaign Group Management
Update Multiple Campaign GroupsFetch a Campaign Group by IDSearch for Campaign GroupsUpdate Campaign GroupDelete a Campaign GroupDelete Multiple Campaign Groups
Use Cases-Account structure-Campaign Mangement
Fetch a Campaign using Campaign IDUpdate multiple campaigns using BATCHSearch for Campaign using criteriaUpdate Campaign Using campaignIdArchive a CampaignDelete campaign Using campaign IdDelete multiple campaigns using BATCH
Use Cases-Account structure-Creative Management
Fetch a Creative using Creative IDFetch multiple Creatives using BATCHCreate multiple Creatives using BATCHSearch Creative using CriteriaUpdate Creative Using Creative IdDelete Creative Using Creative IdDelete multiple Creatives using BATCH
Use Cases-Advertising and Targeting-Ads Targeting
Fetch the Ad Targeting FacetsFind Entities by URNs
Use Cases-Advertising and Targeting-Ads Forecasting
Ad Supply Forecast API
Use Cases-Advertising and Targeting-Ad Creation-Image Ad Creation-Sponsored Content
2. Register Upload3. Upload the image file (select an image file in the Body for Qodex to use)4. Check the status of the upload5. Create a share6. Create a Campaign for the Image Ad7. Create a Creative for the Image Ad
Use Cases-Advertising and Targeting-Ad Creation-Image Ad Creation-Direct Sponsored Content (dark shares)
2. Register Upload3. Upload the image file Copy (select an image file in the Body for Qodex to use)4. Check the status of the upload5. Create a dark share7. Create a Creative for the Image Ad
Use Cases-Advertising and Targeting-Ad Creation-Video Ad Creation-Sponsored Content
2. Register Video Upload3. Upload the video file (select a video file in the Body for Qodex to use)4. Check the status of the upload5. Create Post6. Create a Campaign for the Video Ad7. Create a Creative for the Video Ad
Use Cases-Advertising and Targeting-Ad Creation-Document Ad Creation
2. Register Document Upload3. Upload the Document file (select a document file in the Body for Qodex to use)4. Check the status of the upload5. Create Post6. Create a Campaign for the Document Ad7. Create a Creative for the Document Ad
Use Cases-Advertising and Targeting-Audience Counts
Find audience count by targeting criteria
Community Management
Use Cases-Social Actions Notifications-Organization Social Actions Notifications - Push Workflow
2. Create a share with Company Mention3. Create a subscription request4. Retrieve subscription for authenticated members5. Retrieve Subscription by Key6. Remove a Subscription
Use Cases-Social Actions Notifications-Organization Social Actions Notifications - Pull Workflow
2. Create a share with a Company Mention3. Retrieve Notifications for the authenticated member's organization
Use Cases-Statistics APIs-Organization Follower Statistics
Time-Bound follower statistics
Use Cases-Statistics APIs-Organization Page Statistics
Lifetime Page Statistics
Use Cases-Statistics APIs-Organization Share Statistics
Time Bound Share Statistics
Use Cases-Organization Followers
Search By KeywordSearch By Vanity URL
Use Cases-Organization Lookup-Organizations
Find Organization by Email DomainLookup by Organization Primary TypeFind Non-Administered OrganizationRetrieve Organization Follower Count
Use Cases-Organization Lookup-Organization Brands
Batch GET on Administered Organization BrandsRetrieve an Administered Organization BrandBatch GET on Non-Administered Organization BrandsFind Administered Organization Brands by Parent Org
Use Cases-Organization Access Controls
Find Organization Access Control
Content APIs
Use Cases-InMail Content
Create InMail ContentGet InMail ContentUpdate InMail ContentBatch Get InMail ContentSend Test InMail
Use Cases-Image Ad
Upload an ImageInitialize Image UploadGet a single ImageGet Multiple ImagesFetch multiple Image ContentGet Image Content
Use Cases-Video Ad
Upload a VideoInitialize Video UploadGet a single videoGet Multiple Videos
Use Cases-Creatives
Create an Sponsored CreativeGet a Sponsored CreativeSearch for CreativeUpdate a CreativeDelete a Creative
Use Cases-Posts
Create Organic PostGet Posts by URNFind post by AccountUpdate a PostDelete a Post
Use Cases-Conversation Ad-Sponsored Conversations
Create a Sponsored ConversationGet a Sponsored ConversationGet Multiple Sponsored ConversationsUpdate a Sponsored Conversation
Use Cases-Conversation Ad-Sponsored Message Contents
Batch create Sponsored Message ContentGet Sponsored Message ContentBatch get Sponsored Message ContentUpdate Sponsored Message ContentBatch update Sponsored Message ContentBatch delete Sponsored Message Content
Use Cases-Dynamic Follower Ad
Create a Dynamic Follower AdGet a Dynamic Follower AdUpdate a Dynamic Follower AdDelete a Dynamic Follower Ad
Use Cases-Spotlight Ad
Create a Dynamic Spotlight AdGet a Dynamic Spotlight AdUpdate a Dynamic Spotlight AdDelete a Dynamic Spotlight Ad
Use Cases-Document Ad
Upload the Document file (select a document file in the Body for Qodex to use)Initialize Document UploadGet a single documentGet multiple documentsCreate document contentFetch multiple document content
Conversions API
Conversion Events Streaming Workflow
2. Retrieve authenticated user's Sponsored Ad Accounts4. Fetch existing Conversion Rules for CAPI in the selected ad account6. Create a new Conversion Rule7. Fetch active campaigns8. Associate campaigns to conversion rule10. Stream multiple conversion events to the conversion rule
Lead Sync
Use Cases-Organic
3. Get the user's organization(s) (company pages)5. Get forms for the user's Organization8. [PULL] Schedule periodic form response (lead) pulls8. [PUSH] Subscribe for lead notification webhooks9. [PUSH] Fetch full lead data after a lead notification is received[PUSH] Delete a registered webhook by id
Use Cases-Sponsored
2. Get the user's sponsored accounts (ad accounts)4. Validate the user's organization role5. Get forms for the chosen Sponsored Account8. [PULL] Schedule periodic form response (lead) pulls8. [PUSH] Subscribe for lead notification webhooks9. [PUSH] Fetch full lead data after a lead notification is received[PUSH] Delete a registered webhook by id
Media Planning
Ad Targeting Entities
Get a list of available Ad Targeting FacetsGet Bing Geo locations using search typeahead
Fetch Media Plan
Forecast Avg Lifetime Frequency
Reporting & ROI
Use Cases-Ad Analytics
By Member Company with name & website projection
Use Cases-B2B Templates-Standard Metrics
Demographics - Member Title
Use Cases-B2B Templates-ABM Metrics
Account Engagement Bundle
Use Cases-B2B Templates-Conversions Deep Dive
Conversions by Member Company Size
Introduction
(Legacy) Ads Lead Generation
(Legacy) Use Cases-(Legacy) Push workflow
2. Retrieve the user's Ad Accounts (sponsoredAccount)4. Look up the ad accounts organization5. Validate user's organization role6. Retrieve Lead Gen Forms8. Retrieve past leads looking back 90 days9. Register for lead notifications11. Fetch full lead data after a notification is receivedDelete a registered webhook
(Legacy) Use Cases-(Legacy) Pull workflow
2. Retrieve the user's Ad Accounts (sponsoredAccount)4. Look up the ad accounts organization Copy5. Validate user's organization role Copy6. Retrieve Lead Gen Forms Copy9. Retrieve past leads looking back 90 days
(Legacy) Events Lead Generation
(Legacy) Use Cases-(Legacy) Pull Workflow
2. Get the user's organization(s) (company pages)4. Get user's events tied to the chosen organization6. Get Lead Gen Form tied to the user's Events9. Schedule periodic form response (lead) pulls
Audience Insights
Ad Targeting Entities
Get a list of available Ad Targeting FacetsGet Bing Geo locations using search typeahead
Fetch Audience Insights
What are the top interests of Directors in Finance and in the US?
Audiences
Use Cases-Streaming Companies - Account Targeting
2. Retrieve the user's Ad Accounts (sponsoredAccount)8. Monitor Status of the Company DMP Segments6. Create a Company DMP Segment7. Stream company data - add or remove multiple companies
Use Cases-Streaming Users - Contact Targeting
2. Retrieve the user's Ad Accounts (sponsoredAccount)8. Monitor Status of the User DMP Segments6. Create a User DMP segment (skip this step if the user chose to update an existing Audience)7. Stream user data - add or remove multiple users
Use Cases-CSV list upload - Account & Contact Targeting
2. Retrieve the user's Ad Accounts (sponsoredAccount)6. Create list upload DMP Segment7. Attach the Uploaded List to the List Upload DMP Segment8. Monitor Status of the List Upload DMP Segments
Campaign Management
Use Cases-Account structure-User Access
Create Ad Account UserFetch an Ad Account UserFetch the Authenticated User's Ad AccountsFetch the Authenticated User's Organization RolesUpdate Existing Ad Account UserDelete an Ad Account User
Use Cases-Account structure-Account Management
Create a Test Ad AccountFetch the Ad Account by IDSearch Account by TypeUpdate Ad Account Name
Use Cases-Account structure-Campaign Group Management
Update Multiple Campaign GroupsFetch a Campaign Group by IDSearch for Campaign GroupsUpdate Campaign GroupDelete a Campaign GroupDelete Multiple Campaign Groups
Use Cases-Account structure-Campaign Mangement
Fetch a Campaign using Campaign IDUpdate multiple campaigns using BATCHSearch for Campaign using criteriaUpdate Campaign Using campaignIdArchive a CampaignDelete campaign Using campaign IdDelete multiple campaigns using BATCH
Use Cases-Account structure-Creative Management
Fetch a Creative using Creative IDFetch multiple Creatives using BATCHCreate multiple Creatives using BATCHSearch Creative using CriteriaUpdate Creative Using Creative IdDelete Creative Using Creative IdDelete multiple Creatives using BATCH
Use Cases-Advertising and Targeting-Ads Targeting
Fetch the Ad Targeting FacetsFind Entities by URNs
Use Cases-Advertising and Targeting-Ads Forecasting
Ad Supply Forecast API
Use Cases-Advertising and Targeting-Ad Creation-Image Ad Creation-Sponsored Content
2. Register Upload3. Upload the image file (select an image file in the Body for Qodex to use)4. Check the status of the upload5. Create a share6. Create a Campaign for the Image Ad7. Create a Creative for the Image Ad
Use Cases-Advertising and Targeting-Ad Creation-Image Ad Creation-Direct Sponsored Content (dark shares)
2. Register Upload3. Upload the image file Copy (select an image file in the Body for Qodex to use)4. Check the status of the upload5. Create a dark share7. Create a Creative for the Image Ad
Use Cases-Advertising and Targeting-Ad Creation-Video Ad Creation-Sponsored Content
2. Register Video Upload3. Upload the video file (select a video file in the Body for Qodex to use)4. Check the status of the upload5. Create Post6. Create a Campaign for the Video Ad7. Create a Creative for the Video Ad
Use Cases-Advertising and Targeting-Ad Creation-Document Ad Creation
2. Register Document Upload3. Upload the Document file (select a document file in the Body for Qodex to use)4. Check the status of the upload5. Create Post6. Create a Campaign for the Document Ad7. Create a Creative for the Document Ad
Use Cases-Advertising and Targeting-Audience Counts
Find audience count by targeting criteria
Community Management
Use Cases-Social Actions Notifications-Organization Social Actions Notifications - Push Workflow
2. Create a share with Company Mention3. Create a subscription request4. Retrieve subscription for authenticated members5. Retrieve Subscription by Key6. Remove a Subscription
Use Cases-Social Actions Notifications-Organization Social Actions Notifications - Pull Workflow
2. Create a share with a Company Mention3. Retrieve Notifications for the authenticated member's organization
Use Cases-Statistics APIs-Organization Follower Statistics
Time-Bound follower statistics
Use Cases-Statistics APIs-Organization Page Statistics
Lifetime Page Statistics
Use Cases-Statistics APIs-Organization Share Statistics
Time Bound Share Statistics
Use Cases-Organization Followers
Search By KeywordSearch By Vanity URL
Use Cases-Organization Lookup-Organizations
Find Organization by Email DomainLookup by Organization Primary TypeFind Non-Administered OrganizationRetrieve Organization Follower Count
Use Cases-Organization Lookup-Organization Brands
Batch GET on Administered Organization BrandsRetrieve an Administered Organization BrandBatch GET on Non-Administered Organization BrandsFind Administered Organization Brands by Parent Org
Use Cases-Organization Access Controls
Find Organization Access Control
Content APIs
Use Cases-InMail Content
Create InMail ContentGet InMail ContentUpdate InMail ContentBatch Get InMail ContentSend Test InMail
Use Cases-Image Ad
Upload an ImageInitialize Image UploadGet a single ImageGet Multiple ImagesFetch multiple Image ContentGet Image Content
Use Cases-Video Ad
Upload a VideoInitialize Video UploadGet a single videoGet Multiple Videos
Use Cases-Creatives
Create an Sponsored CreativeGet a Sponsored CreativeSearch for CreativeUpdate a CreativeDelete a Creative
Use Cases-Posts
Create Organic PostGet Posts by URNFind post by AccountUpdate a PostDelete a Post
Use Cases-Conversation Ad-Sponsored Conversations
Create a Sponsored ConversationGet a Sponsored ConversationGet Multiple Sponsored ConversationsUpdate a Sponsored Conversation
Use Cases-Conversation Ad-Sponsored Message Contents
Batch create Sponsored Message ContentGet Sponsored Message ContentBatch get Sponsored Message ContentUpdate Sponsored Message ContentBatch update Sponsored Message ContentBatch delete Sponsored Message Content
Use Cases-Dynamic Follower Ad
Create a Dynamic Follower AdGet a Dynamic Follower AdUpdate a Dynamic Follower AdDelete a Dynamic Follower Ad
Use Cases-Spotlight Ad
Create a Dynamic Spotlight AdGet a Dynamic Spotlight AdUpdate a Dynamic Spotlight AdDelete a Dynamic Spotlight Ad
Use Cases-Document Ad
Upload the Document file (select a document file in the Body for Qodex to use)Initialize Document UploadGet a single documentGet multiple documentsCreate document contentFetch multiple document content
Conversions API
Conversion Events Streaming Workflow
2. Retrieve authenticated user's Sponsored Ad Accounts4. Fetch existing Conversion Rules for CAPI in the selected ad account6. Create a new Conversion Rule7. Fetch active campaigns8. Associate campaigns to conversion rule10. Stream multiple conversion events to the conversion rule
Lead Sync
Use Cases-Organic
3. Get the user's organization(s) (company pages)5. Get forms for the user's Organization8. [PULL] Schedule periodic form response (lead) pulls8. [PUSH] Subscribe for lead notification webhooks9. [PUSH] Fetch full lead data after a lead notification is received[PUSH] Delete a registered webhook by id
Use Cases-Sponsored
2. Get the user's sponsored accounts (ad accounts)4. Validate the user's organization role5. Get forms for the chosen Sponsored Account8. [PULL] Schedule periodic form response (lead) pulls8. [PUSH] Subscribe for lead notification webhooks9. [PUSH] Fetch full lead data after a lead notification is received[PUSH] Delete a registered webhook by id
Media Planning
Ad Targeting Entities
Get a list of available Ad Targeting FacetsGet Bing Geo locations using search typeahead
Fetch Media Plan
Forecast Avg Lifetime Frequency
Reporting & ROI
Use Cases-Ad Analytics
By Member Company with name & website projection
Use Cases-B2B Templates-Standard Metrics
Demographics - Member Title
Use Cases-B2B Templates-ABM Metrics
Account Engagement Bundle
Use Cases-B2B Templates-Conversions Deep Dive
Conversions by Member Company Size
HomeMedia PlanningFetch Media Plan

Fetch Media Plan

Number of APIs: 1

  1. Forecast Avg Lifetime Frequency POST {{baseUrl}}/mediaPlanning?action=forecastImpressions
Previous
Get Bing Geo locations using search typeahead
Next
Forecast Avg Lifetime Frequency