(Legacy) Ads Lead Generation

(Legacy) Use Cases-(Legacy) Push workflow

2. Retrieve the user's Ad Accounts (sponsoredAccount)4. Look up the ad accounts organization 5. Validate user's organization role 6. Retrieve Lead Gen Forms 8. Retrieve past leads looking back 90 days 9. Register for lead notifications 11. Fetch full lead data after a notification is received Delete a registered webhook

(Legacy) Use Cases-(Legacy) Pull workflow

2. Retrieve the user's Ad Accounts (sponsoredAccount)4. Look up the ad accounts organization Copy 5. Validate user's organization role Copy 6. Retrieve Lead Gen Forms Copy 9. 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 organization 6. Get Lead Gen Form tied to the user's Events 9. Schedule periodic form response (lead) pulls

Audience Insights

Ad Targeting Entities

Get a list of available Ad Targeting Facets Get Bing Geo locations using search typeahead

Fetch Audience Insights

What are the top interests of Directors in Finance and in the US?

Use Cases-Streaming Companies - Account Targeting

2. Retrieve the user's Ad Accounts (sponsoredAccount)8. Monitor Status of the Company DMP Segments 6. Create a Company DMP Segment 7. 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 Segments 6. 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 Segment 7. Attach the Uploaded List to the List Upload DMP Segment 8. Monitor Status of the List Upload DMP Segments

Campaign Management

Use Cases-Account structure-User Access

Create Ad Account User Fetch an Ad Account User Fetch the Authenticated User's Ad Accounts Fetch the Authenticated User's Organization Roles Update Existing Ad Account User Delete an Ad Account User

Use Cases-Account structure-Account Management

Create a Test Ad Account Fetch the Ad Account by ID Search Account by Type Update Ad Account Name

Use Cases-Account structure-Campaign Group Management

Update Multiple Campaign Groups Fetch a Campaign Group by ID Search for Campaign Groups Update Campaign Group Delete a Campaign Group Delete Multiple Campaign Groups

Use Cases-Account structure-Campaign Mangement

Fetch a Campaign using Campaign ID Update multiple campaigns using BATCH Search for Campaign using criteria Update Campaign Using campaignId Archive a Campaign Delete campaign Using campaign Id Delete multiple campaigns using BATCH

Use Cases-Account structure-Creative Management

Fetch a Creative using Creative ID Fetch multiple Creatives using BATCH Create multiple Creatives using BATCH Search Creative using Criteria Update Creative Using Creative Id Delete Creative Using Creative Id Delete multiple Creatives using BATCH

Use Cases-Advertising and Targeting-Ads Targeting

Fetch the Ad Targeting Facets Find 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 Upload 3. Upload the image file (select an image file in the Body for Qodex to use)4. Check the status of the upload 5. Create a share 6. Create a Campaign for the Image Ad 7. Create a Creative for the Image Ad

Use Cases-Advertising and Targeting-Ad Creation-Image Ad Creation-Direct Sponsored Content (dark shares)

2. Register Upload 3. Upload the image file Copy (select an image file in the Body for Qodex to use)4. Check the status of the upload 5. Create a dark share 7. Create a Creative for the Image Ad

Use Cases-Advertising and Targeting-Ad Creation-Video Ad Creation-Sponsored Content

2. Register Video Upload 3. Upload the video file (select a video file in the Body for Qodex to use)4. Check the status of the upload 5. Create Post 6. Create a Campaign for the Video Ad 7. Create a Creative for the Video Ad

Use Cases-Advertising and Targeting-Ad Creation-Document Ad Creation

2. Register Document Upload 3. Upload the Document file (select a document file in the Body for Qodex to use)4. Check the status of the upload 5. Create Post 6. Create a Campaign for the Document Ad 7. 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 Mention 3. Create a subscription request 4. Retrieve subscription for authenticated members 5. Retrieve Subscription by Key 6. Remove a Subscription

Use Cases-Social Actions Notifications-Organization Social Actions Notifications - Pull Workflow

2. Create a share with a Company Mention 3. 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 Keyword Search By Vanity URL

Use Cases-Organization Lookup-Organizations

Find Organization by Email Domain Lookup by Organization Primary Type Find Non-Administered Organization Retrieve Organization Follower Count

Use Cases-Organization Lookup-Organization Brands

Batch GET on Administered Organization Brands Retrieve an Administered Organization Brand Batch GET on Non-Administered Organization Brands Find Administered Organization Brands by Parent Org

Use Cases-Organization Access Controls

Find Organization Access Control

Use Cases-InMail Content

Create InMail Content Get InMail Content Update InMail Content Batch Get InMail Content Send Test InMail

Use Cases-Image Ad

Upload an Image Initialize Image Upload Get a single Image Get Multiple Images Fetch multiple Image Content Get Image Content

Use Cases-Video Ad

Upload a Video Initialize Video Upload Get a single video Get Multiple Videos

Use Cases-Creatives

Create an Sponsored Creative Get a Sponsored Creative Search for Creative Update a Creative Delete a Creative

Use Cases-Posts

Create Organic Post Get Posts by URN Find post by Account Update a Post Delete a Post

Use Cases-Conversation Ad-Sponsored Conversations

Create a Sponsored Conversation Get a Sponsored Conversation Get Multiple Sponsored Conversations Update a Sponsored Conversation

Use Cases-Conversation Ad-Sponsored Message Contents

Batch create Sponsored Message Content Get Sponsored Message Content Batch get Sponsored Message Content Update Sponsored Message Content Batch update Sponsored Message Content Batch delete Sponsored Message Content

Use Cases-Dynamic Follower Ad

Create a Dynamic Follower Ad Get a Dynamic Follower Ad Update a Dynamic Follower Ad Delete a Dynamic Follower Ad

Use Cases-Spotlight Ad

Create a Dynamic Spotlight Ad Get a Dynamic Spotlight Ad Update a Dynamic Spotlight Ad Delete 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 Upload Get a single document Get multiple documents Create document content Fetch multiple document content

Conversions API

Conversion Events Streaming Workflow

2. Retrieve authenticated user's Sponsored Ad Accounts 4. Fetch existing Conversion Rules for CAPI in the selected ad account 6. Create a new Conversion Rule 7. Fetch active campaigns 8. Associate campaigns to conversion rule 10. Stream multiple conversion events to the conversion rule

Use Cases-Organic

3. Get the user's organization(s) (company pages)5. Get forms for the user's Organization 8. [PULL] Schedule periodic form response (lead) pulls 8. [PUSH] Subscribe for lead notification webhooks 9. [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 role 5. Get forms for the chosen Sponsored Account 8. [PULL] Schedule periodic form response (lead) pulls 8. [PUSH] Subscribe for lead notification webhooks 9. [PUSH] Fetch full lead data after a lead notification is received [PUSH] Delete a registered webhook by id

Ad Targeting Entities

Get a list of available Ad Targeting Facets Get 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

(Legacy) Ads Lead Generation

(Legacy) Use Cases-(Legacy) Push workflow

2. Retrieve the user's Ad Accounts (sponsoredAccount)4. Look up the ad accounts organization 5. Validate user's organization role 6. Retrieve Lead Gen Forms 8. Retrieve past leads looking back 90 days 9. Register for lead notifications 11. Fetch full lead data after a notification is received Delete a registered webhook

(Legacy) Use Cases-(Legacy) Pull workflow

2. Retrieve the user's Ad Accounts (sponsoredAccount)4. Look up the ad accounts organization Copy 5. Validate user's organization role Copy 6. Retrieve Lead Gen Forms Copy 9. 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 organization 6. Get Lead Gen Form tied to the user's Events 9. Schedule periodic form response (lead) pulls

Audience Insights

Ad Targeting Entities

Get a list of available Ad Targeting Facets Get Bing Geo locations using search typeahead

Fetch Audience Insights

What are the top interests of Directors in Finance and in the US?

Use Cases-Streaming Companies - Account Targeting

2. Retrieve the user's Ad Accounts (sponsoredAccount)8. Monitor Status of the Company DMP Segments 6. Create a Company DMP Segment 7. 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 Segments 6. 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 Segment 7. Attach the Uploaded List to the List Upload DMP Segment 8. Monitor Status of the List Upload DMP Segments

Campaign Management

Use Cases-Account structure-User Access

Create Ad Account User Fetch an Ad Account User Fetch the Authenticated User's Ad Accounts Fetch the Authenticated User's Organization Roles Update Existing Ad Account User Delete an Ad Account User

Use Cases-Account structure-Account Management

Create a Test Ad Account Fetch the Ad Account by ID Search Account by Type Update Ad Account Name

Use Cases-Account structure-Campaign Group Management

Update Multiple Campaign Groups Fetch a Campaign Group by ID Search for Campaign Groups Update Campaign Group Delete a Campaign Group Delete Multiple Campaign Groups

Use Cases-Account structure-Campaign Mangement

Fetch a Campaign using Campaign ID Update multiple campaigns using BATCH Search for Campaign using criteria Update Campaign Using campaignId Archive a Campaign Delete campaign Using campaign Id Delete multiple campaigns using BATCH

Use Cases-Account structure-Creative Management

Fetch a Creative using Creative ID Fetch multiple Creatives using BATCH Create multiple Creatives using BATCH Search Creative using Criteria Update Creative Using Creative Id Delete Creative Using Creative Id Delete multiple Creatives using BATCH

Use Cases-Advertising and Targeting-Ads Targeting

Fetch the Ad Targeting Facets Find 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 Upload 3. Upload the image file (select an image file in the Body for Qodex to use)4. Check the status of the upload 5. Create a share 6. Create a Campaign for the Image Ad 7. Create a Creative for the Image Ad

Use Cases-Advertising and Targeting-Ad Creation-Image Ad Creation-Direct Sponsored Content (dark shares)

2. Register Upload 3. Upload the image file Copy (select an image file in the Body for Qodex to use)4. Check the status of the upload 5. Create a dark share 7. Create a Creative for the Image Ad

Use Cases-Advertising and Targeting-Ad Creation-Video Ad Creation-Sponsored Content

2. Register Video Upload 3. Upload the video file (select a video file in the Body for Qodex to use)4. Check the status of the upload 5. Create Post 6. Create a Campaign for the Video Ad 7. Create a Creative for the Video Ad

Use Cases-Advertising and Targeting-Ad Creation-Document Ad Creation

2. Register Document Upload 3. Upload the Document file (select a document file in the Body for Qodex to use)4. Check the status of the upload 5. Create Post 6. Create a Campaign for the Document Ad 7. 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 Mention 3. Create a subscription request 4. Retrieve subscription for authenticated members 5. Retrieve Subscription by Key 6. Remove a Subscription

Use Cases-Social Actions Notifications-Organization Social Actions Notifications - Pull Workflow

2. Create a share with a Company Mention 3. 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 Keyword Search By Vanity URL

Use Cases-Organization Lookup-Organizations

Find Organization by Email Domain Lookup by Organization Primary Type Find Non-Administered Organization Retrieve Organization Follower Count

Use Cases-Organization Lookup-Organization Brands

Batch GET on Administered Organization Brands Retrieve an Administered Organization Brand Batch GET on Non-Administered Organization Brands Find Administered Organization Brands by Parent Org

Use Cases-Organization Access Controls

Find Organization Access Control

Use Cases-InMail Content

Create InMail Content Get InMail Content Update InMail Content Batch Get InMail Content Send Test InMail

Use Cases-Image Ad

Upload an Image Initialize Image Upload Get a single Image Get Multiple Images Fetch multiple Image Content Get Image Content

Use Cases-Video Ad

Upload a Video Initialize Video Upload Get a single video Get Multiple Videos

Use Cases-Creatives

Create an Sponsored Creative Get a Sponsored Creative Search for Creative Update a Creative Delete a Creative

Use Cases-Posts

Create Organic Post Get Posts by URN Find post by Account Update a Post Delete a Post

Use Cases-Conversation Ad-Sponsored Conversations

Create a Sponsored Conversation Get a Sponsored Conversation Get Multiple Sponsored Conversations Update a Sponsored Conversation

Use Cases-Conversation Ad-Sponsored Message Contents

Batch create Sponsored Message Content Get Sponsored Message Content Batch get Sponsored Message Content Update Sponsored Message Content Batch update Sponsored Message Content Batch delete Sponsored Message Content

Use Cases-Dynamic Follower Ad

Create a Dynamic Follower Ad Get a Dynamic Follower Ad Update a Dynamic Follower Ad Delete a Dynamic Follower Ad

Use Cases-Spotlight Ad

Create a Dynamic Spotlight Ad Get a Dynamic Spotlight Ad Update a Dynamic Spotlight Ad Delete 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 Upload Get a single document Get multiple documents Create document content Fetch multiple document content

Conversions API

Conversion Events Streaming Workflow

2. Retrieve authenticated user's Sponsored Ad Accounts 4. Fetch existing Conversion Rules for CAPI in the selected ad account 6. Create a new Conversion Rule 7. Fetch active campaigns 8. Associate campaigns to conversion rule 10. Stream multiple conversion events to the conversion rule

Use Cases-Organic

3. Get the user's organization(s) (company pages)5. Get forms for the user's Organization 8. [PULL] Schedule periodic form response (lead) pulls 8. [PUSH] Subscribe for lead notification webhooks 9. [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 role 5. Get forms for the chosen Sponsored Account 8. [PULL] Schedule periodic form response (lead) pulls 8. [PUSH] Subscribe for lead notification webhooks 9. [PUSH] Fetch full lead data after a lead notification is received [PUSH] Delete a registered webhook by id

Ad Targeting Entities

Get a list of available Ad Targeting Facets Get 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

Home Content APIs Use Cases-Document AdInitialize Document Upload

Initialize Document Upload

POST {{baseUrl}}/documents?action=initializeUpload

Request Params

Key	Datatype	Required	Description
`action`	string

Upload the Document file (select a document file in the Body for Qodex to use)

Get a single document