Jivox API Documentation
v1.0
Title
Message
Create new category
What is the title of your new category?
Edit page index title
What is the title of the page index?
Edit category
What is the new title of your category?
Edit link
What is the new title and URL of your link?
Bulk Tag
Copy Markdown
Open in ChatGPT
Open in Claude
Overview
The Jivox IQ platform supports the generation of Jivox ad tags against a media plan for the campaigns built on the platform. The ad tags are trafficked using DSPs to be displayed on websites or mobile applications. It allows users to generate a large number of bulk tags to save time and manual effort. Jivox Programmable Personalization API allows users to generate tags in bulk.
Methods
| Method Name | Method Type | Description |
|---|---|---|
| List Media-Plans | GET | Gets media plans for a given user account. |
| Get Import Media Plan Data | POST | This is to parse the csv file which needs to be uploaded when creating or updating a media plan. |
| Import Media Plan Data (Saving a Media Plan) | POST | Saves a new media plan for a given account. |
| Edit an Existing Media Plan | PATCH | Updates an existing media plan for an account. |
| Mail MediaPlan | GET | Mail an existing media plan to all the given email address |
| Download MediaPlan | GET | Downloads an existing media plan in csv format. |
| List Formatted DSP and Placement | GET | Lists all the DSP and placement related information for a given media plan. |
| Get Tag Variables | GET | Gets all the DSP to Datasignal to macro mapping for a given campaign. |
| Create Tag Variable Map | POST | Creates a DSP to Datasignal to macro mapping for a given campaign. |
| Update Tag Variable | PUT | Updates an existing DSP to Datasignal to macro mapping for a given campaign. |
| Create Bulk Tag | POST | Initiate bulk tag generation for a single/list of DSP for a given media plan and campaign. |
| Bulk Tag Generation Status | GET | Gets the current tag generation count and total count for a given tag generation Id. |
| Get Tags for DSP | GET | Gets list of tags created for a given DSP for the given media plan and campaign. |
| Get Tags for Placement | GET | Gets list of tags created for a given placementId for the given media plan and campaign. |
| Download Tags | GET | Downloads in csv format, the list of generated tags for a given DSP/Placement for the given media plan and campaign. |
| Mail Tags | REQUEST | Mails the list of generated tags for a given DSP/Placement for the given media plan and campaign. |
| Get Ad Unit Details For Placement | GET | Gets all possible ad units to generate a tag for a given placement. |
| Create Single Tag Rich-Media | POST | Creates a new rich-media tag for the given placementId. |
| Create Single Tag for Instream-Video | POST | Creates a new instream-video tag for a given placement |
| Create Single Tag for Inbanner-Video | POST | Creates a new inbanner-video tag for a given placement. |
| Create Single Tag for Mobile-InWeb | POST | Creates a new mobile-inweb tag for a given placement. |
| Create Single Tag for Native Ad | POST | Creates a new Native tag for a given placement. |
| Add Placement API | POST | Creates a new placement under the selected media plan. |
| Edit Placement API | PATCH | Updates the placement. |
| Update DSP API | PATCH | Updates the DSP details. |
| List Trackers | GET | List out all trackers available for a placement for a given campaign and media plan. |
| Update Tracker | PUT | Update trackers for a particular media plan used in a given campaign. |
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Last updated on
Was this page helpful?
Next to read:
Media planDiscard Changes
Do you want to discard your current changes and overwrite with the template?
Archive Synced Block
Message
Create new Template
What is this template's title?
Delete Template
Message