Video Creatives (v1.0)

Download OpenAPI description
Languages
Servers
Mock server
https://apidocs.mediamath.com/_mock/apis/video-creatives/
https://t1.mediamath.com/

Classification

_

Operations

IAB

_

Operations

Video Creative Management

_

Operations

Get Video Creative Companions

Request

Get Video Creative Companions

Path
video_idstringrequired

Video ID

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}/companions'

Responses

Create Video Creative Companions

Request

Create Video Creative Companions

Path
video_idstringrequired

Video ID

Bodyapplication/json

_

any
curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}/companions' \
  -H 'Content-Type: application/json'

Responses

List All Video Creatives

Request

List All Video Creatives

Query
withstring

_

sort_bystring

_

qstring

_

page_offsetinteger

_

page_limitinteger

_

fullstring

_

Bodyapplication/json

_

any
curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/api/v2.0/atomic_creatives?full=string&page_limit=0&page_offset=0&q=string&sort_by=string&with=string' \
  -H 'Content-Type: application/json'

Responses

Bodyapplication/vnd.mediamath.v1+json
Response
application/vnd.mediamath.v1+json
{ "data": [ {}, {} ], "meta": { "called_on": "2019-12-16T17:13:37+0000", "count": 2, "etag": "9d7da947e480db19bc565372471a4463788dda12", "next_page": "https://api.mediamath.com/api/v2.0/atomic_creatives?full=*&page_limit=2&page_offset=2", "offset": 0, "status": "ok", "total_count": 63004 }, "uuid": "65D510FE-2027-11EA-B7C6-43D7668E900B" }

Upload Video Creative

Request

Upload Video Creative

Path
video_idintegerrequired

Video ID

Bodymultipart/form-data
keystring

_

filestring

_

curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}/upload' \
  -H 'Content-Type: multipart/form-data' \
  -F key=string \
  -F file=string

Responses

Get Video Creative

Request

Get Video Creative

Path
video_idstringrequired

Video ID

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}'

Responses

Update Video Creative

Request

Update Video Creative

Path
video_idstringrequired

Video ID

curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}'

Responses

Get Video Creative Variants

Request

Get all encoded video variants for the creative, including asset path and video info.

Path
video_idstringrequired

Video ID

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}/variants'

Responses

Get Video Creative Variant

Request

Get Video Creative Variant

Path
variant_idstringrequired

Variant ID

video_idstringrequired

Video ID

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}/variants/{variant_id}'

Responses

Get Video Creative Status

Request

Get Video Creative Status

Path
video_idstringrequired

Video ID

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}/status'

Responses

Delete Video Creative Companion

Request

Delete Video Creative Companion

Path
companion_idstringrequired

Companion ID

video_idstringrequired

Video ID

Bodyapplication/json

_

any
curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}/companions/{companion_id}/delete' \
  -H 'Content-Type: application/json'

Responses

Validate VAST XML

Request

Validate VAST XML

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/validateVAST

Responses

Create Video Creative

Request

Create Video Creative

Bodyapplication/json

_

any
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives \
  -H 'Content-Type: application/json'

Responses

Display a Specific Video Creative

Request

Display a Specific Video Creative

Path
atomic_creative_idintegerrequired

_

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/api/v2.0/atomic_creatives/{atomic_creative_id}'

Responses

Bodyapplication/json
Response
application/json
{ "data": { "ad_format": "DISPLAY", "advertiser_id": 214138, "approval_status": "APPROVED", "built": false, "built_by_user_id": 26802, "concept_id": 2502139, "created_on": "2019-12-16T15:03:12+0000", "entity_type": "atomic_creative", "expansion_direction": "NONRESTRICTED", "expansion_trigger": "MOUSEOVER", "external_identifier": "STUB", "file_type": "vast", "has_sound": false, "height": 0, "id": 7445839, "is_https": true, "is_mraid": false, "is_multi_creative": false, "last_modified": "2019-12-16T15:03:14+0000", "last_payload_modified": "2019-12-16T15:03:13+0000", "media_type": "video", "name": "test_vpaid_3", "rich_media": false, "sizmek_creative_status": "NOT_USED", "sizmek_tag_status": "NOT_USED", "status": true, "t1as": false, "tag": "<div>DUMMY_VAST</div>", "tag_type": "SCRIPT_NOSCRIPT", "tpas_ad_tag_name": "unknown.stub", "updated_on": "2019-12-16T15:03:14+0000", "vast_version": 2, "version": 2, "width": 0 }, "meta": { "called_on": "2019-12-16T16:51:26+0000", "etag": "54fe81494915c471b811661e4c860285a1e67a95", "status": "ok" }, "uuid": "4CD39DF8-2024-11EA-BCBC-7100712346FC" }

Get Video creative VAST XML

Request

This get endpoint returns an XML of video creative instead of a JSON

Path
video_idintegerrequired

_

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}/vast'

Responses

Update creative VAST with Extension node

Request

POST Request: Header with Content-Type: application/xml, body with XML tag as mentioned in desription

Path
video_idstringrequired

_

curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/video-creatives/video/v2.0/creatives/{video_id}/vast/extension'

Responses

Bodyapplication/json
Response
application/json
{ "status": { "code": "ok" } }