Get an Atomic Creative

Organizations

Operations

Agencies

Operations

Advertisers

Operations

Campaigns

Operations

Campaigns Budget Flights

Operations

Campaign Plans

Operations

Strategies

Operations

Strategy Parameters

Operations

Strategy Templates

Operations

New Strategy Plans

Operations

Targeting

Operations

Targeting Attachments

TargetingAttachments

Operations

Targeting Segments

Operations

Targeting Segment Objectives

Operations

Vendor Contracts

Operations

Contracts

Operations

Audience Vendors

Operations

Vendors

Operations

Atomic Creatives

Operations

List Atomic Creatives

Request

Get a list of atomic creatives

Security

Auth0

curl -i -X GET \
  https://api.mediamath.com/api/v3.0/atomic_creatives \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Atomic creative collection response

Bodyapplication/json

dataArray of objects(atomic_creative_response)

metaobject(pagination metadata)

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Create atomic creative

Request

Create an atomic creative

Security

Auth0

Bodyapplication/json

widthintegerrequired

namestring[ 1 .. 256 ] characters

heightintegerrequired

creative_import_file_idinteger

file_typestring

Default "unknown"

Enum"swf""gif""html5""jpg""jpeg""tiff""tif""png""unknown""vast"

is_multi_creativeboolean

Default false

has_soundboolean

Default false

rich_mediaboolean

Default false

rich_media_providerstring

builtboolean

Default false

build_datestring

build_errorsstring

external_identifierstring[ 1 .. 64 ] charactersrequired

expandstring

expansion_triggerstring

Default "MOUSEOVER"

Enum"AUTOMATIC""MOUSEOVER""CLICK"

tpas_ad_tagstring

edited_tagstring

click_through_urlstring or null(uri)<= 2048 characters

concept_idinteger or null

statusboolean

Default true

is_mraidboolean

Default false

is_httpsboolean

Default false

t1asboolean

Default false

start_datestring or null

end_datestring or null

vast_versionnumber or null(float)[ 0 .. 9.9 ]

is_audioboolean or null

expansion_directionstring<= 19 characters

Default "NONRESTRICTED"

media_typestring

Default "display"

Enum"display""video""mobile"

ad_server_typestring

ad_formatstring

Default "DISPLAY"

Enum"DISPLAY""MOBILE""EXPANDABLE""FBX""COMPONENT"

approval_statusstring

Default "PENDING"

Enum"PENDING""APPROVED""REJECTED"

tpas_ad_tag_namestring[ 1 .. 255 ] characters

click_urlstring or null(uri)

sizmek_tag_statusstring

Default "NOT_USED"

sizmek_creative_statusstring

Default "NOT_USED"

advertiser_idinteger>= 1required

tagstring

tag_typestring

Enum"IFRAME_SCRIPT_NOSCRIPT""IFRAME_SCRIPT""IFRAME_NOSCRIPT""IFRAME_IMG""SCRIPT_NOSCRIPT""SCRIPT""NOSCRIPT""IFRAME""IMG""VIDEO"

vendor_idsArray of integers

curl -i -X POST \
  https://api.mediamath.com/api/v3.0/atomic_creatives \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "width": 0,
    "name": "string",
    "height": 0,
    "creative_import_file_id": 0,
    "file_type": "swf",
    "is_multi_creative": false,
    "has_sound": false,
    "rich_media": false,
    "rich_media_provider": "string",
    "built": false,
    "build_date": "string",
    "build_errors": "string",
    "external_identifier": "string",
    "expand": "string",
    "expansion_trigger": "AUTOMATIC",
    "tpas_ad_tag": "string",
    "edited_tag": "string",
    "click_through_url": "http://example.com",
    "concept_id": 0,
    "status": true,
    "is_mraid": false,
    "is_https": false,
    "t1as": false,
    "start_date": "string",
    "end_date": "string",
    "vast_version": 9.9,
    "is_audio": true,
    "expansion_direction": "NONRESTRICTED",
    "media_type": "display",
    "ad_server_type": "string",
    "ad_format": "DISPLAY",
    "approval_status": "PENDING",
    "tpas_ad_tag_name": "string",
    "click_url": "http://example.com",
    "sizmek_tag_status": "NOT_USED",
    "sizmek_creative_status": "NOT_USED",
    "advertiser_id": 1,
    "tag": "string",
    "tag_type": "IFRAME_SCRIPT_NOSCRIPT",
    "vendor_ids": [
      0
    ]
  }'

Responses

Atomic creative response

Bodyapplication/json

dataobject(atomic_creative_response)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 0,
    "version": 0,
    "entity_type": "string",
    "advertiser_id": 0,
    "concept_id": 0,
    "concept_name": "string",
    "name": "string",
    "width": 0,
    "height": 0,
    "creative_import_file_id": 0,
    "file_type": "string",
    "is_https": true,
    "is_multi_creative": true,
    "has_sound": true,
    "rich_media": true,
    "rich_media_provider": "string",
    "status": true,
    "built": true,
    "build_date": "string",
    "built_by_user_id": 0,
    "build_errors": "string",
    "created_on": "2019-08-24T14:15:22Z",
    "last_modified": "string",
    "external_identifier": "string",
    "tpas_ad_tag_name": "string",
    "updated_on": "2019-08-24T14:15:22Z",
    "expand": "string",
    "click_url": "string",
    "ad_format": "string",
    "expansion_direction": "NONRESTRICTED",
    "expansion_trigger": "AUTOMATIC",
    "ad_server_type": "string",
    "t1as": true,
    "tpas_ad_tag": "string",
    "edited_tag": "string",
    "click_through_url": "string",
    "rejected_reason": "string",
    "approval_status": "string",
    "start_date": "string",
    "end_date": "string",
    "media_type": "string",
    "is_mraid": true,
    "vast_version": 9.9,
    "sizmek_tag_status": "string",
    "sizmek_creative_status": "string",
    "last_payload_modified": "string",
    "is_audio": true,
    "tag": "string",
    "tag_type": "string",
    "targeted_strategies": { … },
    "atomic_creative_ssl_validators": { … },
    "vendors": [ … ],
    "creative_assets": [ … ]
  },
  "meta": {
    "status": "success"
  }
}

Get an Atomic Creative

Request

Get an atomic creative by ID

Security

Auth0

Path

atomic_creative_idintegerrequired

Numeric ID of the atomic creative to get

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/atomic_creatives/{atomic_creative_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Atomic creative response

Bodyapplication/json

dataobject(atomic_creative_response)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 0,
    "version": 0,
    "entity_type": "string",
    "advertiser_id": 0,
    "concept_id": 0,
    "concept_name": "string",
    "name": "string",
    "width": 0,
    "height": 0,
    "creative_import_file_id": 0,
    "file_type": "string",
    "is_https": true,
    "is_multi_creative": true,
    "has_sound": true,
    "rich_media": true,
    "rich_media_provider": "string",
    "status": true,
    "built": true,
    "build_date": "string",
    "built_by_user_id": 0,
    "build_errors": "string",
    "created_on": "2019-08-24T14:15:22Z",
    "last_modified": "string",
    "external_identifier": "string",
    "tpas_ad_tag_name": "string",
    "updated_on": "2019-08-24T14:15:22Z",
    "expand": "string",
    "click_url": "string",
    "ad_format": "string",
    "expansion_direction": "NONRESTRICTED",
    "expansion_trigger": "AUTOMATIC",
    "ad_server_type": "string",
    "t1as": true,
    "tpas_ad_tag": "string",
    "edited_tag": "string",
    "click_through_url": "string",
    "rejected_reason": "string",
    "approval_status": "string",
    "start_date": "string",
    "end_date": "string",
    "media_type": "string",
    "is_mraid": true,
    "vast_version": 9.9,
    "sizmek_tag_status": "string",
    "sizmek_creative_status": "string",
    "last_payload_modified": "string",
    "is_audio": true,
    "tag": "string",
    "tag_type": "string",
    "targeted_strategies": { … },
    "atomic_creative_ssl_validators": { … },
    "vendors": [ … ],
    "creative_assets": [ … ]
  },
  "meta": {
    "status": "success"
  }
}

Update an atomic creative

Request

Update an atomic creative by ID

Security

Auth0

Path

atomic_creative_idintegerrequired

Numeric ID of the atomic creative to update

Bodyapplication/json

namestring[ 1 .. 256 ] characters

versioninteger

external_identifierstring[ 1 .. 64 ] characters

advertiser_idinteger>= 1

widthinteger

heightinteger

concept_idinteger or null

statusboolean

is_mraidboolean

is_httpsboolean

t1asboolean

start_datestring or null

end_datestring or null

vast_versionnumber or null(float)[ 0 .. 9.9 ]

is_audioboolean or null

expansion_directionstring<= 19 characters

Default "NONRESTRICTED"

expansion_triggerstring

Default "MOUSEOVER"

Enum"AUTOMATIC""MOUSEOVER""CLICK"

media_typestring

Enum"display""video""mobile"

ad_server_typestring

ad_formatstring

Default "DISPLAY"

Enum"DISPLAY""MOBILE""EXPANDABLE""FBX""COMPONENT"

approval_statusstring

Enum"PENDING""APPROVED""REJECTED"

tpas_ad_tagstring

tpas_ad_tag_namestring[ 1 .. 255 ] characters

click_through_urlstring or null(uri)<= 2048 characters

click_urlstring or null(uri)

edited_tagstring

tagstring

tag_typestring

Enum"IFRAME_SCRIPT_NOSCRIPT""IFRAME_SCRIPT""IFRAME_NOSCRIPT""IFRAME_IMG""SCRIPT_NOSCRIPT""SCRIPT""NOSCRIPT""IFRAME""IMG""VIDEO"

vendor_idsArray of integers

curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/atomic_creatives/{atomic_creative_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "version": 0,
    "external_identifier": "string",
    "advertiser_id": 1,
    "width": 0,
    "height": 0,
    "concept_id": 0,
    "status": true,
    "is_mraid": true,
    "is_https": true,
    "t1as": true,
    "start_date": "string",
    "end_date": "string",
    "vast_version": 9.9,
    "is_audio": true,
    "expansion_direction": "NONRESTRICTED",
    "expansion_trigger": "AUTOMATIC",
    "media_type": "display",
    "ad_server_type": "string",
    "ad_format": "DISPLAY",
    "approval_status": "PENDING",
    "tpas_ad_tag": "string",
    "tpas_ad_tag_name": "string",
    "click_through_url": "http://example.com",
    "click_url": "http://example.com",
    "edited_tag": "string",
    "tag": "string",
    "tag_type": "IFRAME_SCRIPT_NOSCRIPT",
    "vendor_ids": [
      0
    ]
  }'

Responses

Atomic creative response

Bodyapplication/json

dataobject(atomic_creative_response)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 0,
    "version": 0,
    "entity_type": "string",
    "advertiser_id": 0,
    "concept_id": 0,
    "concept_name": "string",
    "name": "string",
    "width": 0,
    "height": 0,
    "creative_import_file_id": 0,
    "file_type": "string",
    "is_https": true,
    "is_multi_creative": true,
    "has_sound": true,
    "rich_media": true,
    "rich_media_provider": "string",
    "status": true,
    "built": true,
    "build_date": "string",
    "built_by_user_id": 0,
    "build_errors": "string",
    "created_on": "2019-08-24T14:15:22Z",
    "last_modified": "string",
    "external_identifier": "string",
    "tpas_ad_tag_name": "string",
    "updated_on": "2019-08-24T14:15:22Z",
    "expand": "string",
    "click_url": "string",
    "ad_format": "string",
    "expansion_direction": "NONRESTRICTED",
    "expansion_trigger": "AUTOMATIC",
    "ad_server_type": "string",
    "t1as": true,
    "tpas_ad_tag": "string",
    "edited_tag": "string",
    "click_through_url": "string",
    "rejected_reason": "string",
    "approval_status": "string",
    "start_date": "string",
    "end_date": "string",
    "media_type": "string",
    "is_mraid": true,
    "vast_version": 9.9,
    "sizmek_tag_status": "string",
    "sizmek_creative_status": "string",
    "last_payload_modified": "string",
    "is_audio": true,
    "tag": "string",
    "tag_type": "string",
    "targeted_strategies": { … },
    "atomic_creative_ssl_validators": { … },
    "vendors": [ … ],
    "creative_assets": [ … ]
  },
  "meta": {
    "status": "success"
  }
}

Atomic Creative Audit Log

Request

Get a list changes to this atomic creative

Security

Auth0

Path

atomic_creative_idintegerrequired

Numeric ID of the atomic creative

Query

page_limitinteger[ 1 .. 1000 ]

Number of elements in the collection to retrieve

Example: page_limit=100

page_offsetinteger[ 0 .. 1000 ]

Index of the first element in the collection to retrieve

Example: page_offset=0

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/atomic_creatives/{atomic_creative_id}/history?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Audit log response

Bodyapplication/json

dataArray of objects or null

metaobject(pagination metadata)

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Healthcheck for Atomic Creatives

Request

Endpoint to check the health of atomic creatives by ID(s).

Security

Auth0

Query

qstringrequired

Query parameter to specify the atomic creative ID(s). Format:

For multiple IDs: atomic_creative_id==(id1, id2)
For a single ID: atomic_creative_id==id

Examples:

Single ID q=atomic_creative_id==11884513

Multiple IDs q=atomic_creative_id==(11884513, 11884508)

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/atomic_creatives/healthcheck?q=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Atomic creative healthcheck response

Bodyapplication/json

dataArray of objects(atomic_creative_healthcheck_response)

metaobject(pagination metadata)

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Bulk Update Atomic Creatives

Request

Update multiple atomic creatives

Security

Auth0

Bodyapplication/json

atomic_creativesobject

curl -i -X POST \
  https://api.mediamath.com/api/v3.0/bulk_update/atomic_creatives \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "atomic_creatives": {
      "create": [
        {
          "width": 0,
          "name": "string",
          "height": 0,
          "creative_import_file_id": 0,
          "file_type": "swf",
          "is_multi_creative": false,
          "has_sound": false,
          "rich_media": false,
          "rich_media_provider": "string",
          "built": false,
          "build_date": "string",
          "build_errors": "string",
          "external_identifier": "string",
          "expand": "string",
          "expansion_trigger": "AUTOMATIC",
          "tpas_ad_tag": "string",
          "edited_tag": "string",
          "click_through_url": "http://example.com",
          "concept_id": 0,
          "status": true,
          "is_mraid": false,
          "is_https": false,
          "t1as": false,
          "start_date": "string",
          "end_date": "string",
          "vast_version": 9.9,
          "is_audio": true,
          "expansion_direction": "NONRESTRICTED",
          "media_type": "display",
          "ad_server_type": "string",
          "ad_format": "DISPLAY",
          "approval_status": "PENDING",
          "tpas_ad_tag_name": "string",
          "click_url": "http://example.com",
          "sizmek_tag_status": "NOT_USED",
          "sizmek_creative_status": "NOT_USED",
          "advertiser_id": 1,
          "tag": "string",
          "tag_type": "IFRAME_SCRIPT_NOSCRIPT",
          "vendor_ids": [
            0
          ]
        }
      ],
      "update": [
        {
          "id": 0,
          "name": "string",
          "version": 0,
          "external_identifier": "string",
          "advertiser_id": 1,
          "width": 0,
          "height": 0,
          "concept_id": 0,
          "status": true,
          "is_mraid": true,
          "is_https": true,
          "t1as": true,
          "start_date": "string",
          "end_date": "string",
          "vast_version": 9.9,
          "is_audio": true,
          "expansion_direction": "NONRESTRICTED",
          "expansion_trigger": "AUTOMATIC",
          "media_type": "display",
          "ad_server_type": "string",
          "ad_format": "DISPLAY",
          "approval_status": "PENDING",
          "tpas_ad_tag": "string",
          "tpas_ad_tag_name": "string",
          "click_through_url": "http://example.com",
          "click_url": "http://example.com",
          "edited_tag": "string",
          "tag": "string",
          "tag_type": "IFRAME_SCRIPT_NOSCRIPT",
          "vendor_ids": [
            0
          ]
        }
      ]
    }
  }'

Responses

Atomic creative bulk response

Bodyapplication/json

dataArray of objects(atomic_creative_response)

metaobject(pagination metadata)

errorsArray of objects(bulk errors)

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  },
  "errors": [
    { … }
  ]
}

Concepts

Operations

Creatives

Operations

Pixel Bundles

Operations

Pixel Providers

Operations

Marketplaces

Operations

Users

Operations

User Permissions

Operations

Enterprise Controls

Operations

General

Operations

Currency Rates

Operations

Site Lists

Operations

Timezones

Operations

Verticals

Operations

Supply Sources

Operations

Ad Servers

Operations

Segment Groups

Operations

Campaigns API (xx.xx.xx)

Organizations

Agencies

Advertisers

Campaigns

Campaigns Budget Flights

Campaign Plans

Strategies

Strategy Parameters

Strategy Templates

New Strategy Plans

Targeting

Targeting Attachments

Targeting Segments

Targeting Segment Objectives

Vendor Contracts

Contracts

Audience Vendors

Vendors

Atomic Creatives

List Atomic Creatives

Request

Responses

Was this helpful?

Create atomic creative

Request

Responses

Was this helpful?

Get an Atomic Creative

Request

Responses

Was this helpful?

Update an atomic creative

Request

Responses

Was this helpful?

Atomic Creative Audit Log

Request

Responses

Was this helpful?

Healthcheck for Atomic Creatives

Request

Responses

Was this helpful?

Bulk Update Atomic Creatives

RequestExpand all

Responses

Was this helpful?

Concepts

Creatives

Pixel Bundles

Pixel Providers

Marketplaces

Users

User Permissions

Enterprise Controls

General

Currency Rates

Site Lists

Timezones

Verticals

Supply Sources

Ad Servers

Segment Groups

Request