Skip to content

List ad specifications

GET
/ad-specifications

Returns list of available adspecs

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successfully retrieved ad specs

object
meta
object
pagination
Pagination section

Contains page and count information for lists

object
count

Number of items returned in this response

integer
totalCount

Total number of items in collection

integer
page

Current page

integer
totalPages

Total number of pages in collection

integer
data
Array<object>
AdSpecification

Object representing an adspec

object
id

Internal adspec ID

integer
name

Adspec name

string
createdAt

Date of adspec creation

date
updatedAt

Date of adspec update (can be null)

date
type

Adspec type (display or video)

string
shareURL

Shared/public adspec URL

string
isDefault

Whether or not adspec is default for current customer and adspec type

bool
isPublic

Whether or not adspec is public/shared.

bool

401

Section titled “401 ”

401 Authentication failed

401 Authentication failed response

Unable to authenticate user

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

404

Section titled “404 ”

404 Not found

404 Not found response

Requested resource or underlying resource was not found

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string

422

Section titled “422 ”

422 Unprocessable entity

422 Unprocessable entity

There is something wrong with the content of the request, typically missing or improperly formatted fields

object
error
Error section

Contains issue information for error responses

object
responseCode

HTTP response code for verification against header response

integer
issues

Detailed information on the issues that triggered the error

Array<object>
Error issue

Issue when returned as part of error section in unsuccessful response

object
type

Advalidation issue type key (please quote when reaching out to support)

string
message

Human readable issue description

string
relatedField

Specific field in the request that the issue relates to

string