Ad360 logo
Documentation Powered by ReDoc

Ad360 Campaign Manager API Documentation (v1.0beta)

Download OpenAPI specification:Download

This is the documentation for the Ad360 Campaign Manager API. You can find out more about Ad360 at https://www.ad360.media.

Introduction

Ad360 is a Next-Generation Media Buying Platform. It is an advertising platform giving you tools to set up, manage and optimize your advertising campaigns across multiple advertising channels (search, social, programmatic display & video). It harnesses the power of Artificial Intelligence to deliver better results to your advertising campaigns so that your business outcomes are maximized.

Getting access to Ad360 API

Before being able to use the Ad360 product, you need to sign the Ad360 Master Services Agreement and go through the onboarding process. This is to ensure that the platform is calibrated according to your needs. The first step before being able to use the Ad360 platform is to get in touch with the Ad360 Sales Team. To do so, we recommend using the "CONTACT US" form in the Ad360 website: http://www.ad360.media/#contact-us Explain your needs in the form and the Sales team will get back to you. After signing the Ad360 Master Service Agreement, you will receive the onboarding instructions to access the Ad360 platform. To receive an API key, please let the Sales team or your Ad360 Account manager know that you request access to the API and they will walk you through the API onboarding process.

Help Center and contacting Support teams

If you don't know where to start with Ad360, you should visit our Help center: https://support.ad360.media/hc/en-us. The Ad360 Help Center contains guides and articles, including a step-by-step guide to get you up & running and learn how to use Ad360, its Campaign Manager console and API. If you require additional help, you can submit a request to Ad360 Support team on any page of the Help Center thanks to the '(?) Help' button. You can also create a ticket directly from this page: https://support.ad360.media/hc/en-us/requests/new.

Authentication

Ad360ClientAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

CognitoAuth

Security Scheme Type API Key
Header parameter name: Authorization

SearchLogAuthorizer

Security Scheme Type API Key
Header parameter name: Authorization

Auth

Get Auth Token

Retrieves the Auth Token using username and password.

Authorizations:
Ad360ClientAuth
header Parameters
x-api-key
required
string
Request Body schema: application/json

Username and Password.

username
string
password
string

Responses

200

200 response

400

400 response

post/auth
https://api.ad360.media/v1/auth

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "token": "eyJraWQiOiJ4djVKNm10eUVvSkVFXC8ydXRCYjJnc1ZiWkJBV2dXRUw2aFgwQlllbWNsdz0iLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoibWpMMlBEQ0o2dWJ4eUZ4M1hiOXRrdyIsInN1YiI6Ijg1YzQyYjNmLTdlNjgtNDk1My1iMzdiLTVlYzc5ZjRhMmI5YSIsIndlYnNpdGUiOiJ3d3cuc2t5bGFkcy5jb20iLCJjb2duaXRvOmdyb3VwcyI6WyJTdXBlckFkbWlucyIsIlRyYWRlcnMiXSwiZW1haWxfdmVyaWZpZWQiOnRydWUsImN1c3RvbTphZ2VuY3lJZCI6IjZhOTk5Nzk2LWEzMTMtNGQ0MS05ODNlLWZhNmUwZmViYTliYyIsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC5ldS13ZXN0LTEuYW1hem9uYXdzLmNvbVwvZXUtd2VzdC0xX0RiaXV1SDhldCIsInBob25lX251bWJlcl92ZXJpZmllZCI6dHJ1ZSwiY29nbml0bzp1c2VybmFtZSI6Ijg1YzQyYjNmLTdlNjgtNDk1My1iMzdiLpllYzc5ZjRhMmI5YSIsImdpdmVuX25hbWUiOiJYYXZpZXIiLCJhdWQiOiI3ZmM1YzgyaWVhaGluZTBmYW5vbmtnZ3BvNSIsImV2ZW50X2lkIjoiYThhNjBiNDAtYTkzYi00NjkyLTkzM2YtZDJlMmU4ZTM1MjJhIiwiY3VzdG9tOmFnZW5jeU5hbWUiOiJBZHZlbnR1cmUgTWVkaWEgQWdlbmN5IC0gUGFyaXMsIEZyYW5jZSIsInRva2VuX3VzZSI6ImlkIiwiYXV0aF90aW1lIjoxNTk2Nzg2ODA2LCJuYW1lIjoiWGF2aWVyIExpdHQiLCJwaG9uZV9udW1iZXIiOiIrMzM2NTg4OTc4NzAiLCJleHAiOjE1OTY3OTA0MDYsImlhdCI6MTU5Njc4NjgwNiwiZW1haWwiOiJ4YXZpZXJAc2t5bGFkcy5jb20ifQ.LEf-wLRth6ZWP6B3npTVVy9INMAHJYwB1FPsRN8dMTdF4jl2gOCCE5cK04SlJi-HiAGa9iiCu4ikkIzNfLbjF9j-5yN7QvDMD-5SImLSzJANMs-Rtf2IIPZy4PHpaeEMG2XcuJVPWWOLCw_d7FfTpiF7etSodpp91SjVmgYRs7KULxeZfQ4XnVehlNF69RO6epzt-IjKmnLkoKHu4BLeUts7ettiv_EVEXOzdrDJYgGxQ4_XZnriCnsLXS2_RilugYaXfJEdcQb1B8NqTeBWcBa00nX9kZ5HwTGi1YUKaaAL6Ok2CJvcNYeLXdTboZdaMHTly1h5W8qzEPDnf6CUqw"
}

Account

Create Account

Creates an account which contains advertisers and their related objects. Each account has a separate set of users, which can only access the advertisers belong to that account.

Authorizations:
CognitoAuth

Responses

200

200 response

400

400 response

post/account
https://api.ad360.media/v1/account

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    }
}

Get Account List

Retrieves the list of accounts.

Authorizations:
CognitoAuth
query Parameters
lastKeyAgencyId
required
string
lastKeyDateUpdated
required
integer <int64>
length
required
integer <int32>
term
string

Responses

200

200 response

400

400 response

get/account/list
https://api.ad360.media/v1/account/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyAgencyId": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "lastKeyDateUpdated": 1583224296850,
  • "recordsTotal": 1000
}

Get Account

Gets the account identified by the accountId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
accountId
required
string

Responses

200

200 response

400

400 response

get/account/{accountId}
https://api.ad360.media/v1/account/{accountId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "parentId": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "id": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "agencyName": "Adventure Media France Updated",
  • "website": "https://www.adventuremedia.fr",
  • "approvalStatus": "Approved",
  • "creditLine": 100,
  • "balanceDue": 0,
  • "periodMediaCost": 0,
  • "periodFees": 0,
  • "periodTotalMediaCost": 0,
  • "margin": 0.071,
  • "paymentTerms": "Net60",
  • "currency": "EUR",
  • "activitySummary":
    {
    },
  • "currentActivitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1583224296779,
  • "dateUpdated": 1583224296850
}

Update Account

Updates the account identified by the accountId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
accountId
required
string

Responses

200

200 response

400

400 response

put/account/{accountId}
https://api.ad360.media/v1/account/{accountId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "parentId": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "id": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "agencyName": "Adventure Media France Updated",
  • "website": "https://www.adventuremedia.fr",
  • "approvalStatus": "Approved",
  • "creditLine": 100,
  • "balanceDue": 0,
  • "periodMediaCost": 0,
  • "periodFees": 0,
  • "periodTotalMediaCost": 0,
  • "margin": 0.071,
  • "paymentTerms": "Net60",
  • "currency": "EUR",
  • "activitySummary":
    {
    },
  • "currentActivitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1583224296779,
  • "dateUpdated": 1583224296850
}

Patch Account

Patches the account identified by the accountId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
accountId
required
string

Responses

200

200 response

400

400 response

patch/account/{accountId}
https://api.ad360.media/v1/account/{accountId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "parentId": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "id": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "agencyName": "Adventure Media France Updated",
  • "website": "https://www.adventuremedia.fr",
  • "approvalStatus": "Approved",
  • "creditLine": 100,
  • "balanceDue": 0,
  • "periodMediaCost": 0,
  • "periodFees": 0,
  • "periodTotalMediaCost": 0,
  • "margin": 0.071,
  • "paymentTerms": "Net60",
  • "currency": "EUR",
  • "activitySummary":
    {
    },
  • "currentActivitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1583224296779,
  • "dateUpdated": 1583224296850
}

User

Create User

Creates a User within the account identified by the accountId passed in the request path. Each user has a role, which determines what actions they can perform in their account. Owners have the highest level of permissions, and can change key account settings like billing details and they can promote users to the admin role. Admins can create new users, have access to non-financial settings of their account and can perform all actions with regards to objects within the account. Traders don't have access to the account settings but can perform all actions with regards to the objects in the account. External users only have access to the Reporting section and cannot make changes to any of the objects within the account.

Authorizations:
CognitoAuth
path Parameters
accountId
required
string

Responses

200

200 response

400

400 response

post/account/{accountId}/user
https://api.ad360.media/v1/account/{accountId}/user

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "parentId": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "id": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "agencyName": "Adventure Media France Updated",
  • "website": "https://www.adventuremedia.fr",
  • "approvalStatus": "Approved",
  • "creditLine": 100,
  • "balanceDue": 0,
  • "periodMediaCost": 0,
  • "periodFees": 0,
  • "periodTotalMediaCost": 0,
  • "margin": 0.071,
  • "paymentTerms": "Net60",
  • "currency": "EUR",
  • "activitySummary":
    {
    },
  • "currentActivitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1583224296779,
  • "dateUpdated": 1583224296850
}

Get Account User List

Gets the list of users that belong to the account identified by the accountId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
accountId
required
string

Responses

200

200 response

400

400 response

get/account/{accountId}/user/list
https://api.ad360.media/v1/account/{accountId}/user/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyAppUserId": "c95a4b7d-cffb-45cc-8f27-972922364ea4",
  • "lastKeyDateUpdated": 1589616491289,
  • "recordsTotal": 1000
}

Get User

Gets the user identified by the userId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
userId
required
string
accountId
required
string

Responses

200

200 response

400

400 response

get/account/{accountId}/user/{userId}
https://api.ad360.media/v1/account/{accountId}/user/{userId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "accountId": "c7b44d59-d95d-465a-ba94-14a4be802153",
  • "id": "53c66ebe-b595-4777-b7e5-b568d8270bd8",
  • "firstname": "Tolga",
  • "lastname": "Sayer",
  • "email": "tolga.sayer@ad360.media",
  • "roles":
    [
    ],
  • "locale": "en-US",
  • "active": false,
  • "approvalStatus": "Approved",
  • "dateCreated": 1595426208467,
  • "dateUpdated": 1595426208467
}

Update User

Updates the user identified by the userId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
userId
required
string
accountId
required
string

Responses

200

200 response

400

400 response

put/account/{accountId}/user/{userId}
https://api.ad360.media/v1/account/{accountId}/user/{userId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "accountId": "c7b44d59-d95d-465a-ba94-14a4be802153",
  • "id": "53c66ebe-b595-4777-b7e5-b568d8270bd8",
  • "firstname": "Tolga",
  • "lastname": "Sayer",
  • "email": "tolga.sayer@ad360.media",
  • "roles":
    [
    ],
  • "locale": "en-US",
  • "active": false,
  • "approvalStatus": "Approved",
  • "dateCreated": 1595426208467,
  • "dateUpdated": 1595426208467
}

Patch User

Patches the user identified by the userId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
userId
required
string
accountId
required
string

Responses

200

200 response

400

400 response

patch/account/{accountId}/user/{userId}
https://api.ad360.media/v1/account/{accountId}/user/{userId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "accountId": "c7b44d59-d95d-465a-ba94-14a4be802153",
  • "id": "53c66ebe-b595-4777-b7e5-b568d8270bd8",
  • "firstname": "Tolga",
  • "lastname": "Sayer",
  • "email": "tolga.sayer@ad360.media",
  • "roles":
    [
    ],
  • "locale": "en-US",
  • "active": false,
  • "approvalStatus": "Approved",
  • "dateCreated": 1595426208467,
  • "dateUpdated": 1595426208467
}

Log Book

Create User Log Entry

Creates a log entry for the user identified by the userId passed in the request path. Log Entries allow users to add custom text notes to any entities (Campaign, Line Item, etc), which are then added to a Log that can be reviewed at any time. This can be used by teams to collaborate and share information on their campaigns. They can also use this feature to flag certain entities or save useful information within the Ad360 platform.

Authorizations:
CognitoAuth
path Parameters
userId
required
string
accountId
required
string

Responses

200

200 response

400

400 response

post/account/{accountId}/user/{userId}/logs
https://api.ad360.media/v1/account/{accountId}/user/{userId}/logs

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "userId": "3cb7f633-883c-4587-90ce-d0bc686eet84",
  • "agencyId": "6a999796-a313-4d41-983e-fa6e0feba9n8m",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e514b1k",
  • "demandObjectId": "91aa558a-f3ab-44ab-a522-d5b5fb3ebp87",
  • "demandObject": "Campaign",
  • "logText": "I add new line items to this campaign to address more best performing segments"
}

Delete User Log Entry

Deletes a log entry related to a user, identified by the logId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
userId
required
string
logId
required
string
accountId
required
string

Responses

200

200 response

400

400 response

delete/account/{accountId}/user/{userId}/logs/{logId}
https://api.ad360.media/v1/account/{accountId}/user/{userId}/logs/{logId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "userId": "3cb7f633-883c-4587-90ce-d0bc686eet84",
  • "agencyId": "6a999796-a313-4d41-983e-fa6e0feba9n8m",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e514b1k",
  • "demandObjectId": "91aa558a-f3ab-44ab-a522-d5b5fb3ebp87",
  • "demandObject": "Campaign",
  • "logText": "I add new line items to this campaign to address more best performing segments"
}

Patch User Log Entry

Patches a log entry related to a user, identified by the logId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
userId
required
string
logId
required
string
accountId
required
string

Responses

200

200 response

400

400 response

patch/account/{accountId}/user/{userId}/logs/{logId}
https://api.ad360.media/v1/account/{accountId}/user/{userId}/logs/{logId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "userId": "3cb7f633-883c-4587-90ce-d0bc686eet84",
  • "agencyId": "6a999796-a313-4d41-983e-fa6e0feba9n8m",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e514b1k",
  • "demandObjectId": "91aa558a-f3ab-44ab-a522-d5b5fb3ebp87",
  • "demandObject": "Campaign",
  • "logText": "I add new line items to this campaign to address more best performing segments"
}

Advertiser

Create Advertiser

Creates an Advertiser, which will be able to regroup a number of campaigns, as well as creative assets, segments, site lists and other settings. It's up to you to decide how to group your advertisers and campaigns. You might create an advertiser for all the campaigns you need to run for a particular client. Or you might create separate advertisers for different product lines or divisions. The margin is in decimal value (i.e. entering 0.05 will give a 5% margin).

Authorizations:
CognitoAuth
query Parameters
agencyId
required
string
Request Body schema: application/json

Advertiser object to be created.

agencyId
string
advertiserName
required
string
margin
number
active
boolean

Responses

200

200 response

400

400 response

post/advertiser
https://api.ad360.media/v1/advertiser

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "agencyId": "6a999796-a313-4d41-98te-fa6e0feba9bc",
  • "advertiserName": "FANG Inc",
  • "margin": 0.02,
  • "active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "agencyId": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "advertiserName": "Ad360 Demo Advertiser",
  • "margin": 0.05,
  • "activitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1592489964068,
  • "dateUpdated": 1592489964068
}

Get Advertiser

Gets the list of advertisers that belong to your account.

Authorizations:
CognitoAuth
query Parameters
agencyId
required
string
lastKeyAdvertiserId
required
string
lastKeyDateUpdated
required
integer <int64>
length
required
integer <int32>
term
string

Responses

200

200 response

400

400 response

get/advertiser/list
https://api.ad360.media/v1/advertiser/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyAdvertiserId": "936e5d77-29d6-47be-9db4-16f700ecd26e",
  • "lastKeyDateUpdated": 1585313198312,
  • "recordsTotal": 1000
}

Get Advertiser

Gets the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
query Parameters
agencyId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}
https://api.ad360.media/v1/advertiser/{advertiserId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "agencyId": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "advertiserName": "Ad360 Demo Advertiser",
  • "margin": 0.05,
  • "activitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1592489964068,
  • "dateUpdated": 1592489964068
}

Update Advertiser

Updates the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
query Parameters
agencyId
required
string
Request Body schema: application/json

Advertiser properties to be updated.

advertiserName
string
margin
number
active
boolean

Responses

200

200 response

400

400 response

put/advertiser/{advertiserId}
https://api.ad360.media/v1/advertiser/{advertiserId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "advertiserName": "FANG Inc",
  • "margin": 0.02,
  • "active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "agencyId": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "advertiserName": "Ad360 Demo Advertiser",
  • "margin": 0.05,
  • "activitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1592489964068,
  • "dateUpdated": 1592489964068
}

Patch Advertiser

Patches the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
query Parameters
agencyId
required
string
Request Body schema: application/json

Advertiser properties to be patched.

advertiserName
string
margin
number
active
boolean

Responses

200

200 response

400

400 response

patch/advertiser/{advertiserId}
https://api.ad360.media/v1/advertiser/{advertiserId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "advertiserName": "FANG Inc",
  • "margin": 0.02,
  • "active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "agencyId": "6a999796-a313-4d41-983e-fa6e0feba9bc",
  • "advertiserName": "Ad360 Demo Advertiser",
  • "margin": 0.05,
  • "activitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1592489964068,
  • "dateUpdated": 1592489964068
}

Campaign

Create Campaign

Creates a campaign, belonging to the advertiser identified by the advertiserId passed in the request path. The campaign is defined by a budget, dates, goal and contains the line items that determine which users you will be delivering your ads to. Campaigns are designed by Ad360 in platform-agnostic way, meaning that campaigns allow you to manage your advertising activities independently from the channels they're linked to. One Ad360 campaign can contain multiple line items tht each purchase media from different channels (e.g. Google Ads, Facebook, programmatic display and video).

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
Request Body schema: application/json

Campaign object to be created.

campaignName
required
string
budget
required
number
frequencyCap
object (FrequencyCap)
pacingCap
object (PacingCap)
bidding
object (Bidding)
startDate
required
integer <int64>
endDate
required
integer <int64>
active
boolean

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/campaign
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campaignName": "Promotion Summer 2020",
  • "budget": 12502,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "startDate": 1571785200000,
  • "endDate": 1574812800000,
  • "active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "91aa558a-f3ab-44ab-a522-d5b5fb3eb644",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "campaignName": "Demo Performance Campaign",
  • "budget": 10000,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "margin": 0,
  • "activitySummary":
    {
    },
  • "startDate": 1580037864404,
  • "endDate": 1596754800000,
  • "active": true,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Get Campaign List

Gets the list of campaigns that belong to the advertiser identified by the advertiserId passed in the request path. Campaigns are designed by Ad360 in platform-agnostic way, meaning that campaigns allow you to manage your advertising activities independently from the channels they're linked to. One Ad360 campaign can contain multiple line items tht each purchase media from different channels (e.g. Google Ads, Facebook, programmatic display and video).

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
query Parameters
lastKeyCampaignId
required
string
lastKeyDateUpdated
required
integer <int64>
length
required
integer <int32>
term
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/list
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyCampaignId": "936e5d77-29d6-47be-9db4-16f700ecd26e",
  • "lastKeyDateUpdated": 1585313198312,
  • "recordsTotal": 1000
}

Get Campaign

Gets the campaign identified by the campaignId passed in the request path. The request gives you the campaign's settings, including its budget, start date, end date, goal. Campaigns are designed by Ad360 in platform-agnostic way, meaning that campaigns allow you to manage your advertising activities independently from the channels they're linked to. One Ad360 campaign can contain multiple line items tht each purchase media from different channels (e.g. Google Ads, Facebook, programmatic display and video).

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "91aa558a-f3ab-44ab-a522-d5b5fb3eb644",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "campaignName": "Demo Performance Campaign",
  • "budget": 10000,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "margin": 0,
  • "activitySummary":
    {
    },
  • "startDate": 1580037864404,
  • "endDate": 1596754800000,
  • "active": true,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Update Campaign

Updates the campaign identified by the campaignId passed in the request path. You can change its settings such as budget, start date, end date, goal. Campaigns are designed by Ad360 in platform-agnostic way, meaning that campaigns allow you to manage your advertising activities independently from the channels they're linked to. One Ad360 campaign can contain multiple line items tht each purchase media from different channels (e.g. Google Ads, Facebook, programmatic display and video).

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
Request Body schema: application/json

Campaign properties to be updated.

campaignName
string
budget
number
frequencyCap
object (FrequencyCap)
pacingCap
object (PacingCap)
bidding
object (Bidding)
startDate
integer <int64>
endDate
integer <int64>
active
boolean

Responses

200

200 response

400

400 response

put/advertiser/{advertiserId}/campaign/{campaignId}
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campaignName": "Promotion Summer 2020",
  • "budget": 12502,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "startDate": 1571785200000,
  • "endDate": 1574812800000,
  • "active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "91aa558a-f3ab-44ab-a522-d5b5fb3eb644",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "campaignName": "Demo Performance Campaign",
  • "budget": 10000,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "margin": 0,
  • "activitySummary":
    {
    },
  • "startDate": 1580037864404,
  • "endDate": 1596754800000,
  • "active": true,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Patch Campaign

Patches the campaign identified by the campaignId passed in the request path. Campaigns are designed by Ad360 in platform-agnostic way, meaning that campaigns allow you to manage your advertising activities independently from the channels they're linked to. One Ad360 campaign can contain multiple line items tht each purchase media from different channels (e.g. Google Ads, Facebook, programmatic display and video).

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
Request Body schema: application/json

Campaign properties to be patched.

campaignName
string
budget
number
frequencyCap
object (FrequencyCap)
pacingCap
object (PacingCap)
bidding
object (Bidding)
startDate
integer <int64>
endDate
integer <int64>
active
boolean

Responses

200

200 response

400

400 response

patch/advertiser/{advertiserId}/campaign/{campaignId}
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campaignName": "Promotion Summer 2020",
  • "budget": 12502,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "startDate": 1571785200000,
  • "endDate": 1574812800000,
  • "active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "91aa558a-f3ab-44ab-a522-d5b5fb3eb644",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "campaignName": "Demo Performance Campaign",
  • "budget": 10000,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "margin": 0,
  • "activitySummary":
    {
    },
  • "startDate": 1580037864404,
  • "endDate": 1596754800000,
  • "active": true,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Line Item

Create Line Item

Creates a line item for the campaign identified by the campaignId passed in the request path. Each line item contains settings allowing Ad360 to know which audiences to target and display your advertisements to, such as the audience geolocation, their characteristics, and which creative asset to show them.

path Parameters
advertiserId
required
string
campaignId
required
string
Request Body schema: application/json

LineItem object to be created.

channel
required
string (Channel)
Enum: "GOOGLE_ADS" "FACEBOOK" "GOOGLE_AUTHORIZED_BUYERS" "AD360" "AMAZON"
lineItemName
required
string
budget
required
number
margin
number
frequencyCap
required
object (FrequencyCap)
pacingCap
required
object (PacingCap)
bidding
required
object (Bidding)
creativeWeighting
required
string (CreativeWeighting)
Enum: "Random" "CTR" "CPA" "Custom"
maxBid
required
number
goal
object (Goal)
startDate
required
integer <int64>
endDate
required
integer <int64>
dayParting
Array of objects (DayParting)
verticalsInclude
Array of objects (LineItemDimension)
verticalsExclude
Array of objects (LineItemDimension)
devicesInclude
Array of objects (LineItemDeviceDimension)
devicesExclude
Array of objects (LineItemDeviceDimension)
audienceSegmentsInclude
Array of objects (LineItemDimension)
audienceSegmentsExclude
Array of objects (LineItemDimension)
recencyInclude
integer <int64>
recencyExclude
integer <int64>
sitelistsInclude
Array of objects (LineItemDimension)
sitelistsExclude
Array of objects (LineItemDimension)
languagesInclude
Array of objects (LineItemDimension)
sensitiveCatsExclude
Array of objects (LineItemDimension)
mobileOsInclude
Array of objects (LineItemDimension)
countries
Array of objects (LineItemDimension)
regions
Array of objects (LineItemDimension)
cities
Array of objects (LineItemDimension)
postcodes
Array of objects (LineItemDimension)
creatives
Array of strings
creativesSizes
Array of strings
creativeType
string (CreativeType)
Enum: "Banner" "html5" "Video" "Vast" "Native" "ThirdParty" "Image"
creativesTypes
Array of strings
creativesSet
Array of objects (Creative)
advertiser
object (Advertiser)
campaign
object (Campaign)
platformType
string (PlatformType)
Enum: "PRETARGETING_PLATFORM_MOBILE" "PRETARGETING_PLATFORM_DESKTOP" "PRETARGETING_PLATFORM_TABLET"
googleAb
object (GoogleAb)
qps
integer <int64>
activitySummary
object (ActivitySummary)
active
boolean
dateCreated
integer <int64>
dateUpdated
integer <int64>

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/campaign/{campaignId}/lineitem
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "channel": "Facebook",
  • "lineItemName": "Test Line Item creatives assocation",
  • "budget": 1200.5,
  • "margin": 0,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "creativeWeighting": "CTR",
  • "maxBid": 3,
  • "goal":
    {
    },
  • "startDate": 1586970334399,
  • "endDate": 1597449600000,
  • "dayParting":
    [
    ],
  • "verticalsInclude":
    [
    ],
  • "verticalsExclude":
    [
    ],
  • "devicesInclude":
    [
    ],
  • "devicesExclude":
    [
    ],
  • "audienceSegmentsInclude":
    [
    ],
  • "audienceSegmentsExclude":
    [
    ],
  • "recencyInclude": 1814400000,
  • "recencyExclude": 7776000000,
  • "sitelistsInclude":
    [
    ],
  • "sitelistsExclude":
    [
    ],
  • "languagesInclude":
    [
    ],
  • "sensitiveCatsExclude":
    [
    ],
  • "mobileOsInclude":
    [
    ],
  • "countries":
    [
    ],
  • "regions":
    [
    ],
  • "cities":
    [
    ],
  • "postcodes":
    [
    ],
  • "creatives":
    [
    ],
  • "creativesSizes":
    [
    ],
  • "creativeType": "html5",
  • "creativesTypes":
    [
    ],
  • "creativesSet":
    [
    ],
  • "advertiser":
    {
    },
  • "campaign":
    {
    },
  • "platformType": "PRETARGETING_PLATFORM_MOBILE",
  • "googleAb":
    {
    },
  • "qps": 30,
  • "activitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1596020061143,
  • "dateUpdated": 1596020061143
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "7f9beff9-a00e-4c41-8549-e77c7c37d7aa",
  • "campaignId": "91aa558a-f3ab-44ab-a522-d5b5fb3eb644",
  • "channel": "Facebook",
  • "lineItemName": "Test Line Item creatives assocation",
  • "budget": 1200.5,
  • "margin": 0,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "creativeWeighting": "CTR",
  • "maxBid": 3,
  • "goal":
    {
    },
  • "startDate": 1586970334399,
  • "endDate": 1597449600000,
  • "dayParting":
    [
    ],
  • "verticalsInclude":
    [
    ],
  • "verticalsExclude":
    [
    ],
  • "devicesInclude":
    [
    ],
  • "devicesExclude":
    [
    ],
  • "audienceSegmentsInclude":
    [
    ],
  • "audienceSegmentsExclude":
    [
    ],
  • "recencyInclude": 1814400000,
  • "recencyExclude": 7776000000,
  • "sitelistsInclude":
    [
    ],
  • "sitelistsExclude":
    [
    ],
  • "languagesInclude":
    [
    ],
  • "sensitiveCatsExclude":
    [
    ],
  • "mobileOsInclude":
    [
    ],
  • "countries":
    [
    ],
  • "regions":
    [
    ],
  • "cities":
    [
    ],
  • "postcodes":
    [
    ],
  • "creatives":
    [
    ],
  • "creativesSizes":
    [
    ],
  • "creativeType": "html5",
  • "creativesTypes":
    [
    ],
  • "creativesSet":
    [
    ],
  • "advertiser":
    {
    },
  • "campaign":
    {
    },
  • "platformType": "PRETARGETING_PLATFORM_MOBILE",
  • "googleAb":
    {
    },
  • "qps": 30,
  • "activitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1596020061143,
  • "dateUpdated": 1596020061143
}

Get Line Item List

Gets the list of line items belonging to the campaign identified by the campaignId passed in the request path. Each line item contains settings allowing Ad360 to know which audiences to target and display your advertisements to, such as the audience geolocation, their characteristics, and which creative asset to show them.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
query Parameters
lastKeyLineItemId
required
string
lastKeyDateUpdated
required
integer <int64>
length
required
integer <int32>
term
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/list
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyLineItemId": "7f9beff9-a00e-4c41-8549-e77c7c37d7aa",
  • "lastKeyDateUpdated": 1585313198312,
  • "recordsTotal": 1000
}

Get Line Item

Gets the line item identified by the lineitemId passed in the request path, and its settings such as its dates, budget, bid. This also details its targeteting details including geolocation, audience segments, site lists, contexts, etc.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "7f9beff9-a00e-4c41-8549-e77c7c37d7aa",
  • "campaignId": "91aa558a-f3ab-44ab-a522-d5b5fb3eb644",
  • "channel": "Facebook",
  • "lineItemName": "Test Line Item creatives assocation",
  • "budget": 1200.5,
  • "margin": 0,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "creativeWeighting": "CTR",
  • "maxBid": 3,
  • "goal":
    {
    },
  • "startDate": 1586970334399,
  • "endDate": 1597449600000,
  • "dayParting":
    [
    ],
  • "verticalsInclude":
    [
    ],
  • "verticalsExclude":
    [
    ],
  • "devicesInclude":
    [
    ],
  • "devicesExclude":
    [
    ],
  • "audienceSegmentsInclude":
    [
    ],
  • "audienceSegmentsExclude":
    [
    ],
  • "recencyInclude": 1814400000,
  • "recencyExclude": 7776000000,
  • "sitelistsInclude":
    [
    ],
  • "sitelistsExclude":
    [
    ],
  • "languagesInclude":
    [
    ],
  • "sensitiveCatsExclude":
    [
    ],
  • "mobileOsInclude":
    [
    ],
  • "countries":
    [
    ],
  • "regions":
    [
    ],
  • "cities":
    [
    ],
  • "postcodes":
    [
    ],
  • "creatives":
    [
    ],
  • "creativesSizes":
    [
    ],
  • "creativeType": "html5",
  • "creativesTypes":
    [
    ],
  • "creativesSet":
    [
    ],
  • "advertiser":
    {
    },
  • "campaign":
    {
    },
  • "platformType": "PRETARGETING_PLATFORM_MOBILE",
  • "googleAb":
    {
    },
  • "qps": 30,
  • "activitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1596020061143,
  • "dateUpdated": 1596020061143
}

Update Line Item

Updates the line item identified by the lineitemId passed in the request path. The LineItem will be replaced by the line item spec you pass along with the PUT. If you only want to make minor changes, we recommend doing a GET before to retrieve the existing object and setting its parameters to the new values you want.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string
Request Body schema: application/json

LineItem properties to be updated.

lineItemName
string
budget
number
frequencyCap
object (FrequencyCap)
pacingCap
object (PacingCap)
bidding
object (Bidding)
creativeWeighting
string (CreativeWeighting)
Enum: "Random" "CTR" "CPA" "Custom"
maxBid
number
goal
object (Goal)
startDate
integer <int64>
endDate
integer <int64>
dayParting
Array of objects (DayParting)
verticalsInclude
Array of objects (LineItemDimension)
verticalsExclude
Array of objects (LineItemDimension)
devicesInclude
Array of objects (LineItemDeviceDimension)
devicesExclude
Array of objects (LineItemDeviceDimension)
audienceSegmentsInclude
Array of objects (LineItemDimension)
audienceSegmentsExclude
Array of objects (LineItemDimension)
recencyInclude
integer <int64>
recencyExclude
integer <int64>
sitelistsInclude
Array of objects (LineItemDimension)
sitelistsExclude
Array of objects (LineItemDimension)
languagesInclude
Array of objects (LineItemDimension)
sensitiveCatsExclude
Array of objects (LineItemDimension)
mobileOsInclude
Array of objects (LineItemDimension)
countries
Array of objects (LineItemDimension)
regions
Array of objects (LineItemDimension)
cities
Array of objects (LineItemDimension)
postcodes
Array of objects (LineItemDimension)
creatives
Array of strings
creativesSizes
Array of strings
creativeType
string (CreativeType)
Enum: "Banner" "html5" "Video" "Vast" "Native" "ThirdParty" "Image"
creativesTypes
Array of strings
creativesSet
Array of objects (Creative)
platformType
string (PlatformType)
Enum: "PRETARGETING_PLATFORM_MOBILE" "PRETARGETING_PLATFORM_DESKTOP" "PRETARGETING_PLATFORM_TABLET"
qps
integer <int64>
active
boolean

Responses

200

200 response

400

400 response

put/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "lineItemName": "Test Line Item creatives assocation",
  • "budget": 1200.5,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "creativeWeighting": "CTR",
  • "maxBid": 3,
  • "goal":
    {
    },
  • "startDate": 1586970334399,
  • "endDate": 1597449600000,
  • "dayParting":
    [
    ],
  • "verticalsInclude":
    [
    ],
  • "verticalsExclude":
    [
    ],
  • "devicesInclude":
    [
    ],
  • "devicesExclude":
    [
    ],
  • "audienceSegmentsInclude":
    [
    ],
  • "audienceSegmentsExclude":
    [
    ],
  • "recencyInclude": 1814400000,
  • "recencyExclude": 7776000000,
  • "sitelistsInclude":
    [
    ],
  • "sitelistsExclude":
    [
    ],
  • "languagesInclude":
    [
    ],
  • "sensitiveCatsExclude":
    [
    ],
  • "mobileOsInclude":
    [
    ],
  • "countries":
    [
    ],
  • "regions":
    [
    ],
  • "cities":
    [
    ],
  • "postcodes":
    [
    ],
  • "creatives":
    [
    ],
  • "creativesSizes":
    [
    ],
  • "creativeType": "html5",
  • "creativesTypes":
    [
    ],
  • "creativesSet":
    [
    ],
  • "platformType": "PRETARGETING_PLATFORM_MOBILE",
  • "qps": 30,
  • "active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "7f9beff9-a00e-4c41-8549-e77c7c37d7aa",
  • "campaignId": "91aa558a-f3ab-44ab-a522-d5b5fb3eb644",
  • "channel": "Facebook",
  • "lineItemName": "Test Line Item creatives assocation",
  • "budget": 1200.5,
  • "margin": 0,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "creativeWeighting": "CTR",
  • "maxBid": 3,
  • "goal":
    {
    },
  • "startDate": 1586970334399,
  • "endDate": 1597449600000,
  • "dayParting":
    [
    ],
  • "verticalsInclude":
    [
    ],
  • "verticalsExclude":
    [
    ],
  • "devicesInclude":
    [
    ],
  • "devicesExclude":
    [
    ],
  • "audienceSegmentsInclude":
    [
    ],
  • "audienceSegmentsExclude":
    [
    ],
  • "recencyInclude": 1814400000,
  • "recencyExclude": 7776000000,
  • "sitelistsInclude":
    [
    ],
  • "sitelistsExclude":
    [
    ],
  • "languagesInclude":
    [
    ],
  • "sensitiveCatsExclude":
    [
    ],
  • "mobileOsInclude":
    [
    ],
  • "countries":
    [
    ],
  • "regions":
    [
    ],
  • "cities":
    [
    ],
  • "postcodes":
    [
    ],
  • "creatives":
    [
    ],
  • "creativesSizes":
    [
    ],
  • "creativeType": "html5",
  • "creativesTypes":
    [
    ],
  • "creativesSet":
    [
    ],
  • "advertiser":
    {
    },
  • "campaign":
    {
    },
  • "platformType": "PRETARGETING_PLATFORM_MOBILE",
  • "googleAb":
    {
    },
  • "qps": 30,
  • "activitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1596020061143,
  • "dateUpdated": 1596020061143
}

Patch Line Item

Patches the list of line items identified by the lineitemId passed in the request path. Patching allows you to only change the parameters you're passing with the PATCH request. All other parameters will remain unchanged.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string
Request Body schema: application/json
name
string (AttributeName)
Enum: "active" "maxBid" "bid" "budget" "pacing" "frequency"
value
string

Responses

200

200 response

400

400 response

patch/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "active",
  • "value": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "7f9beff9-a00e-4c41-8549-e77c7c37d7aa",
  • "campaignId": "91aa558a-f3ab-44ab-a522-d5b5fb3eb644",
  • "channel": "Facebook",
  • "lineItemName": "Test Line Item creatives assocation",
  • "budget": 1200.5,
  • "margin": 0,
  • "frequencyCap":
    {
    },
  • "pacingCap":
    {
    },
  • "bidding":
    {
    },
  • "creativeWeighting": "CTR",
  • "maxBid": 3,
  • "goal":
    {
    },
  • "startDate": 1586970334399,
  • "endDate": 1597449600000,
  • "dayParting":
    [
    ],
  • "verticalsInclude":
    [
    ],
  • "verticalsExclude":
    [
    ],
  • "devicesInclude":
    [
    ],
  • "devicesExclude":
    [
    ],
  • "audienceSegmentsInclude":
    [
    ],
  • "audienceSegmentsExclude":
    [
    ],
  • "recencyInclude": 1814400000,
  • "recencyExclude": 7776000000,
  • "sitelistsInclude":
    [
    ],
  • "sitelistsExclude":
    [
    ],
  • "languagesInclude":
    [
    ],
  • "sensitiveCatsExclude":
    [
    ],
  • "mobileOsInclude":
    [
    ],
  • "countries":
    [
    ],
  • "regions":
    [
    ],
  • "cities":
    [
    ],
  • "postcodes":
    [
    ],
  • "creatives":
    [
    ],
  • "creativesSizes":
    [
    ],
  • "creativeType": "html5",
  • "creativesTypes":
    [
    ],
  • "creativesSet":
    [
    ],
  • "advertiser":
    {
    },
  • "campaign":
    {
    },
  • "platformType": "PRETARGETING_PLATFORM_MOBILE",
  • "googleAb":
    {
    },
  • "qps": 30,
  • "activitySummary":
    {
    },
  • "active": true,
  • "dateCreated": 1596020061143,
  • "dateUpdated": 1596020061143
}

Update Line Item Creatives

Updates the creatives associated to the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

put/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/creatives
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/creatives

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyCreativeId": "df1bd808-0b3e-4b61-86df-a881d5e3c49d",
  • "lastKeyDateUpdated": 1587727757977,
  • "recordsTotal": 1000
}

Get Line Item Creatives List

Gets the list of creatives associated to the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/creatives/list
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/creatives/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyCreativeId": "df1bd808-0b3e-4b61-86df-a881d5e3c49d",
  • "lastKeyDateUpdated": 1587727757977,
  • "recordsTotal": 1000
}

Get Line Item DayParting

Gets the dayParting settings of the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/dayparting
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/dayparting

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get Line Item First Party Data

Gets the first party data settings of the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/firstpartydata
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/firstpartydata

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Line Item Languages

Gets the languages settings of the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/languages
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/languages

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Line Item Mobile and OS

Gets the mobile and OS targeting settings of the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/mobileos
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/mobileos

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Line Item Sensitive Categories

Gets the sensitive categories targeting settings of the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/sensitivecats
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/sensitivecats

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Line Item Site Lists

Gets the site lists settings of the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/sitelists
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/sitelists

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get Line Item Verticals

Gets the verticals targeting settings of the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/verticals
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/verticals

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    },
  • {
    }
]

Get Line Item Devices

Gets the devices targeting settings of the line item identified by the lineitemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
lineItemId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/devices
https://api.ad360.media/v1/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/devices

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "html5"
]

Creative

Create Creative

Creates a creative for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/creative
https://api.ad360.media/v1/advertiser/{advertiserId}/creative

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "e62f4d09-611a-46a9-b9ab-bb79389cdfbe",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d6p8250386",
  • "creativeType": "html5",
  • "creativeSize": "Square_300x250",
  • "creativeStatus": "APPROVED",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "width": 300,
  • "height": 250,
  • "clickUrl": "https://www.example.com",
  • "s3Key": "da127dcb/300X250.html",
  • "mainfile": "banner.jpg",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "payload": "payload",
  • "thirdPartyTag": "tag",
  • "duration": 30,
  • "aspectRatio": "auto",
  • "transcodeStatus": "pending",
  • "transcodeJobId": "N/A",
  • "size": 0,
  • "version": 1,
  • "sensitiveCategory": "0",
  • "active": true,
  • "linked": false,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Create Creative of Type Image

Creates a creative of type image for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
Request Body schema: application/json

Creative object to be created.

creativeType
required
string
Value: "Image"
creativeName
required
string
description
string
clickUrl
required
string
mainfile
required
string
creativeSize
required
string

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/creative/image
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/image

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creativeType": "Image",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "clickUrl": "https://www.example.com",
  • "mainfile": "banner.jpg",
  • "creativeSize": "300x250"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "e62f4d09-611a-46a9-b9ab-bb79389cdfbe",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d6p8250386",
  • "creativeType": "html5",
  • "creativeSize": "Square_300x250",
  • "creativeStatus": "APPROVED",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "width": 300,
  • "height": 250,
  • "clickUrl": "https://www.example.com",
  • "s3Key": "da127dcb/300X250.html",
  • "mainfile": "banner.jpg",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "payload": "payload",
  • "thirdPartyTag": "tag",
  • "duration": 30,
  • "aspectRatio": "auto",
  • "transcodeStatus": "pending",
  • "transcodeJobId": "N/A",
  • "size": 0,
  • "version": 1,
  • "sensitiveCategory": "0",
  • "active": true,
  • "linked": false,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Create Creative of Type html5

Creates a creative of type html5 for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
Request Body schema: application/json

Creative object to be created.

creativeType
required
string
Value: "html5"
creativeName
required
string
description
string
clickUrl
required
string
mainfile
required
string
mainsource
required
string
backupImage
string
creativeSize
required
string (CreativeSize)
Enum: "Square_300x250" "Leaderboard_728x90" "Skyscrapper_120x600" "LargeSkyscrapper_160x600" "Square_250x250" "Banner_468x60" "LargeRectangle_336x280" "HalfPageAd_300x600" "LargeLeaderBoard_970x90" "SmallSquare_200x200" "None"

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/creative/html5
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/html5

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creativeType": "html5",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "clickUrl": "https://www.example.com",
  • "mainfile": "mybanner.zip",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "creativeSize": "Square_300x250"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "e62f4d09-611a-46a9-b9ab-bb79389cdfbe",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d6p8250386",
  • "creativeType": "html5",
  • "creativeSize": "Square_300x250",
  • "creativeStatus": "APPROVED",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "width": 300,
  • "height": 250,
  • "clickUrl": "https://www.example.com",
  • "s3Key": "da127dcb/300X250.html",
  • "mainfile": "banner.jpg",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "payload": "payload",
  • "thirdPartyTag": "tag",
  • "duration": 30,
  • "aspectRatio": "auto",
  • "transcodeStatus": "pending",
  • "transcodeJobId": "N/A",
  • "size": 0,
  • "version": 1,
  • "sensitiveCategory": "0",
  • "active": true,
  • "linked": false,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Create Creative of Type ThirdPartyAdTag

Creates a creative of type thirdpartyadtag for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
Request Body schema: application/json

Creative object to be created.

creativeType
required
string
Value: "ThirdPartyAdTag"
creativeName
required
string
description
string
clickUrl
required
string
thirdPartyAdTag
required
string
creativeSize
required
string (CreativeSize)
Enum: "Square_300x250" "Leaderboard_728x90" "Skyscrapper_120x600" "LargeSkyscrapper_160x600" "Square_250x250" "Banner_468x60" "LargeRectangle_336x280" "HalfPageAd_300x600" "LargeLeaderBoard_970x90" "SmallSquare_200x200" "None"

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/creative/thirpartyadtag
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/thirpartyadtag

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creativeType": "ThirdPartyAdTag",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "clickUrl": "https://www.example.com",
  • "thirdPartyAdTag": "string",
  • "creativeSize": "Square_300x250"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "e62f4d09-611a-46a9-b9ab-bb79389cdfbe",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d6p8250386",
  • "creativeType": "html5",
  • "creativeSize": "Square_300x250",
  • "creativeStatus": "APPROVED",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "width": 300,
  • "height": 250,
  • "clickUrl": "https://www.example.com",
  • "s3Key": "da127dcb/300X250.html",
  • "mainfile": "banner.jpg",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "payload": "payload",
  • "thirdPartyTag": "tag",
  • "duration": 30,
  • "aspectRatio": "auto",
  • "transcodeStatus": "pending",
  • "transcodeJobId": "N/A",
  • "size": 0,
  • "version": 1,
  • "sensitiveCategory": "0",
  • "active": true,
  • "linked": false,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Create Creative of Type Video

Creates a creative of type video for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
Request Body schema: application/json

Creative object to be created.

creativeType
required
string
Value: "Video"
creativeName
required
string
description
string
clickUrl
required
string
mainfile
required
string
duration
required
number
aspectRatio
required
string (AspectRatio)
Enum: "auto" "1:1" "4:3" "3:2" "16:9"

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/creative/video
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/video

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creativeType": "Video",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "clickUrl": "https://www.example.com",
  • "mainfile": "myVideo.mp4",
  • "duration": 30,
  • "aspectRatio": "auto"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "e62f4d09-611a-46a9-b9ab-bb79389cdfbe",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d6p8250386",
  • "creativeType": "html5",
  • "creativeSize": "Square_300x250",
  • "creativeStatus": "APPROVED",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "width": 300,
  • "height": 250,
  • "clickUrl": "https://www.example.com",
  • "s3Key": "da127dcb/300X250.html",
  • "mainfile": "banner.jpg",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "payload": "payload",
  • "thirdPartyTag": "tag",
  • "duration": 30,
  • "aspectRatio": "auto",
  • "transcodeStatus": "pending",
  • "transcodeJobId": "N/A",
  • "size": 0,
  • "version": 1,
  • "sensitiveCategory": "0",
  • "active": true,
  • "linked": false,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Create Creative of Type Vast

Creates a creative of type vast for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
Request Body schema: application/json

Creative object to be created.

creativeType
required
string
Value: "Vast"
creativeName
required
string
description
string
clickUrl
required
string
tag
required
string

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/creative/vast
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/vast

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "creativeType": "Vast",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "clickUrl": "https://www.example.com",
  • "tag": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "e62f4d09-611a-46a9-b9ab-bb79389cdfbe",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d6p8250386",
  • "creativeType": "html5",
  • "creativeSize": "Square_300x250",
  • "creativeStatus": "APPROVED",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "width": 300,
  • "height": 250,
  • "clickUrl": "https://www.example.com",
  • "s3Key": "da127dcb/300X250.html",
  • "mainfile": "banner.jpg",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "payload": "payload",
  • "thirdPartyTag": "tag",
  • "duration": 30,
  • "aspectRatio": "auto",
  • "transcodeStatus": "pending",
  • "transcodeJobId": "N/A",
  • "size": 0,
  • "version": 1,
  • "sensitiveCategory": "0",
  • "active": true,
  • "linked": false,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Create Creative in Bulk

Creates creatives in bulk for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/creative/bulk
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/bulk

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Creative Bulk Import

Gets the creative bulk import for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/creative/bulk/import
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/bulk/import

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Creatives Bulk Import List

Gets the list of bulk imports for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/creative/bulk/import/list
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/bulk/import/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyAppUserId": "c95a4b7d-cffb-45cc-8f27-972922364ea4",
  • "lastKeyDateUpdated": 1589616491289,
  • "recordsTotal": 1000
}

Get Creative Bulk Import Batch

Gets details about a creative bulk import batch identified by the batchId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
batchId
required
string
advertiserId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/creative/bulk/import/{batchId}
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/bulk/import/{batchId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Creative Bulk Import Content List

Gets content list of a creative bulk import batch identified by the batchId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
batchId
required
string
advertiserId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/creative/bulk/import/{batchId}/list
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/bulk/import/{batchId}/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Creative List

Gets list of creatives belonging to the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
query Parameters
lastKeyCreativeId
required
string
lastKeyDateUpdated
required
integer <int64>
length
required
integer <int32>
term
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/creative/list
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyCreativeId": "936e5d77-29d6-47be-9db4-16f700ecd26e",
  • "lastKeyDateUpdated": 1585313198312,
  • "recordsTotal": 1000
}

Get Creative

Gets the creative identified by the creativeId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
creativeId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/creative/{creativeId}
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/{creativeId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "e62f4d09-611a-46a9-b9ab-bb79389cdfbe",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d6p8250386",
  • "creativeType": "html5",
  • "creativeSize": "Square_300x250",
  • "creativeStatus": "APPROVED",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "width": 300,
  • "height": 250,
  • "clickUrl": "https://www.example.com",
  • "s3Key": "da127dcb/300X250.html",
  • "mainfile": "banner.jpg",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "payload": "payload",
  • "thirdPartyTag": "tag",
  • "duration": 30,
  • "aspectRatio": "auto",
  • "transcodeStatus": "pending",
  • "transcodeJobId": "N/A",
  • "size": 0,
  • "version": 1,
  • "sensitiveCategory": "0",
  • "active": true,
  • "linked": false,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Update Creative

Updates the creative identified by the creativeId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
creativeId
required
string

Responses

200

200 response

400

400 response

put/advertiser/{advertiserId}/creative/{creativeId}
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/{creativeId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "e62f4d09-611a-46a9-b9ab-bb79389cdfbe",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d6p8250386",
  • "creativeType": "html5",
  • "creativeSize": "Square_300x250",
  • "creativeStatus": "APPROVED",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "width": 300,
  • "height": 250,
  • "clickUrl": "https://www.example.com",
  • "s3Key": "da127dcb/300X250.html",
  • "mainfile": "banner.jpg",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "payload": "payload",
  • "thirdPartyTag": "tag",
  • "duration": 30,
  • "aspectRatio": "auto",
  • "transcodeStatus": "pending",
  • "transcodeJobId": "N/A",
  • "size": 0,
  • "version": 1,
  • "sensitiveCategory": "0",
  • "active": true,
  • "linked": false,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Patch Creative

Patches the creative identified by the creativeId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
creativeId
required
string

Responses

200

200 response

400

400 response

patch/advertiser/{advertiserId}/creative/{creativeId}
https://api.ad360.media/v1/advertiser/{advertiserId}/creative/{creativeId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "e62f4d09-611a-46a9-b9ab-bb79389cdfbe",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d6p8250386",
  • "creativeType": "html5",
  • "creativeSize": "Square_300x250",
  • "creativeStatus": "APPROVED",
  • "creativeName": "myBeautifulBanner",
  • "description": "this is the description of my creative",
  • "width": 300,
  • "height": 250,
  • "clickUrl": "https://www.example.com",
  • "s3Key": "da127dcb/300X250.html",
  • "mainfile": "banner.jpg",
  • "mainsource": "index.html",
  • "backupImage": "backup.gif",
  • "payload": "payload",
  • "thirdPartyTag": "tag",
  • "duration": 30,
  • "aspectRatio": "auto",
  • "transcodeStatus": "pending",
  • "transcodeJobId": "N/A",
  • "size": 0,
  • "version": 1,
  • "sensitiveCategory": "0",
  • "active": true,
  • "linked": false,
  • "dateCreated": 1595675329352,
  • "dateUpdated": 1595675329352
}

Segment

Create Segment

Creates a segment for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/event
https://api.ad360.media/v1/advertiser/{advertiserId}/event

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d605250291",
  • "eventType": "Conversion",
  • "eventName": "Purchase confirmation",
  • "eventGroup": "Conversions"
}

Get Segment List

Gets the list of segments belonging to the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
query Parameters
lastKeyEventId
required
string
lastKeyDateUpdated
required
integer <int64>
length
required
integer <int32>
term
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/event/list
https://api.ad360.media/v1/advertiser/{advertiserId}/event/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "recordsFiltered": 500,
  • "data":
    [
    ],
  • "lastKeyEventId": "936e5d77-29d6-47be-9db4-16f700ecd26e",
  • "lastKeyDateUpdated": 1585313198312,
  • "recordsTotal": 1000
}

Get Advertiser Segment Tree

Gets the tree of segment groups and segments belonging to the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/event/tree
https://api.ad360.media/v1/advertiser/{advertiserId}/event/tree

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "1314cfbb-02cc-42de-bd9e-27d605250386",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d605250386",
  • "eventType": "Conversion",
  • "eventName": "Purchase confirmation",
  • "eventGroup": "Conversions",
  • "loads": 0,
  • "active": false,
  • "dateCreated": 1588602824747,
  • "dateUpdated": 1588602824747
}

Get Segment

Gets the segment identified by the eventId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
eventId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/event/{eventId}
https://api.ad360.media/v1/advertiser/{advertiserId}/event/{eventId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "1314cfbb-02cc-42de-bd9e-27d605250386",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d605250386",
  • "eventType": "Conversion",
  • "eventName": "Purchase confirmation",
  • "eventGroup": "Conversions",
  • "loads": 0,
  • "active": false,
  • "dateCreated": 1588602824747,
  • "dateUpdated": 1588602824747
}

Update Segment

Updates the segment identified by the eventId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
eventId
required
string
advertiserId
required
string

Responses

200

200 response

400

400 response

put/advertiser/{advertiserId}/event/{eventId}
https://api.ad360.media/v1/advertiser/{advertiserId}/event/{eventId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "1314cfbb-02cc-42de-bd9e-27d605250386",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d605250386",
  • "eventType": "Conversion",
  • "eventName": "Purchase confirmation",
  • "eventGroup": "Conversions",
  • "loads": 0,
  • "active": false,
  • "dateCreated": 1588602824747,
  • "dateUpdated": 1588602824747
}

Patch Segment

Patches the segment identified by the eventId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
eventId
required
string
advertiserId
required
string

Responses

200

200 response

400

400 response

patch/advertiser/{advertiserId}/event/{eventId}
https://api.ad360.media/v1/advertiser/{advertiserId}/event/{eventId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "1314cfbb-02cc-42de-bd9e-27d605250386",
  • "advertiserId": "1314cfbb-02cc-42de-bd9e-27d605250386",
  • "eventType": "Conversion",
  • "eventName": "Purchase confirmation",
  • "eventGroup": "Conversions",
  • "loads": 0,
  • "active": false,
  • "dateCreated": 1588602824747,
  • "dateUpdated": 1588602824747
}

Site List

Create Site List

Creates a site list for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string

Responses

200

200 response

400

400 response

post/advertiser/{advertiserId}/sitelist
https://api.ad360.media/v1/advertiser/{advertiserId}/sitelist

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "ee2e3bf4-c252-4e6f-8ab7-0f08b513f08c",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "siteListType": "Blacklist",
  • "siteListName": "April 31 List",
  • "siteListGroup": "test",
  • "siteCount": 0,
  • "publishers":
    [
    ],
  • "active": false,
  • "dateCreated": 1583943950441,
  • "dateUpdated": 1583943950441
}

Get SiteList List

Gets the list of site lists for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
query Parameters
lastKeySiteListId
required
string
lastKeyDateUpdated
required
integer <int64>
length
required
integer <int32>
term
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/sitelist/list
https://api.ad360.media/v1/advertiser/{advertiserId}/sitelist/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "ee2e3bf4-c252-4e6f-8ab7-0f08b513f08c",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "siteListType": "Blacklist",
  • "siteListName": "April 31 List",
  • "siteListGroup": "test",
  • "siteCount": 0,
  • "publishers":
    [
    ],
  • "active": false,
  • "dateCreated": 1583943950441,
  • "dateUpdated": 1583943950441
}

Get Advertiser Site List Tree

Gets the tree of site list groups and site lists belonging to the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/sitelist/tree
https://api.ad360.media/v1/advertiser/{advertiserId}/sitelist/tree

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "ee2e3bf4-c252-4e6f-8ab7-0f08b513f08c",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "siteListType": "Blacklist",
  • "siteListName": "April 31 List",
  • "siteListGroup": "test",
  • "siteCount": 0,
  • "publishers":
    [
    ],
  • "active": false,
  • "dateCreated": 1583943950441,
  • "dateUpdated": 1583943950441
}

Get Site List

Gets details of the site list identified by the sitelistId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
sitelistId
required
string
query Parameters
agencyId
string

Responses

200

200 response

400

400 response

get/advertiser/{advertiserId}/sitelist/{sitelistId}
https://api.ad360.media/v1/advertiser/{advertiserId}/sitelist/{sitelistId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "ee2e3bf4-c252-4e6f-8ab7-0f08b513f08c",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "siteListType": "Blacklist",
  • "siteListName": "April 31 List",
  • "siteListGroup": "test",
  • "siteCount": 0,
  • "publishers":
    [
    ],
  • "active": false,
  • "dateCreated": 1583943950441,
  • "dateUpdated": 1583943950441
}

Update Site List

Updates the site list identified by the sitelistId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
sitelistId
required
string

Responses

200

200 response

400

400 response

put/advertiser/{advertiserId}/sitelist/{sitelistId}
https://api.ad360.media/v1/advertiser/{advertiserId}/sitelist/{sitelistId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "ee2e3bf4-c252-4e6f-8ab7-0f08b513f08c",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "siteListType": "Blacklist",
  • "siteListName": "April 31 List",
  • "siteListGroup": "test",
  • "siteCount": 0,
  • "publishers":
    [
    ],
  • "active": false,
  • "dateCreated": 1583943950441,
  • "dateUpdated": 1583943950441
}

Patch Site List

Patches the site list identified by the sitelistId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
sitelistId
required
string

Responses

200

200 response

400

400 response

patch/advertiser/{advertiserId}/sitelist/{sitelistId}
https://api.ad360.media/v1/advertiser/{advertiserId}/sitelist/{sitelistId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "ee2e3bf4-c252-4e6f-8ab7-0f08b513f08c",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e51492a",
  • "siteListType": "Blacklist",
  • "siteListName": "April 31 List",
  • "siteListGroup": "test",
  • "siteCount": 0,
  • "publishers":
    [
    ],
  • "active": false,
  • "dateCreated": 1583943950441,
  • "dateUpdated": 1583943950441
}

Report

Create Report

Creates a report.

Authorizations:
CognitoAuth

Responses

200

200 response

400

400 response

post/report
https://api.ad360.media/v1/report

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Update Report

Updates a report.

Authorizations:
CognitoAuth

Responses

200

200 response

400

400 response

put/report
https://api.ad360.media/v1/report

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Report List

Gets the list of reports available in your account, based on the filters values entered in the query.

Authorizations:
CognitoAuth
query Parameters
term
string
lastKeyDateUpdated
required
integer <int64>
length
string
agencyId
string
_type
string
lastKeyReportId
string

Responses

200

200 response

400

400 response

get/report/list
https://api.ad360.media/v1/report/list

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Report

Gets the report identified by the reportId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
reportId
required
string

Responses

200

200 response

400

400 response

get/report/{reportId}
https://api.ad360.media/v1/report/{reportId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Search

Get Search Results

Gets search results from your account entities based on the search terms.

query Parameters
start
string
sort
string
q.options
string
q.parser
string
facet.object_type
string
return
string
expr.r
string
q
required
string
size
string

Responses

200

200 response

get/search
https://api.ad360.media/v1/search

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Search Logs

Gets the search logs.

Authorizations:
SearchLogAuthorizer
query Parameters
start
string
sort
string
highlight.log_text
string
facet.object_type
string
q.options
string
q.parser
string
return
string
and
string
expr.r
string
q
required
string
size
string
fq
string

Responses

200

200 response

get/search/logs
https://api.ad360.media/v1/search/logs

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "userId": "3cb7f633-883c-4587-90ce-d0bc686eet84",
  • "agencyId": "6a999796-a313-4d41-983e-fa6e0feba9n8m",
  • "advertiserId": "5e1e03ec-5b92-44a6-8a94-05571e514b1k",
  • "demandObjectId": "91aa558a-f3ab-44ab-a522-d5b5fb3ebp87",
  • "demandObject": "Campaign",
  • "logText": "I add new line items to this campaign to address more best performing segments"
}

Time Series

Get Advertiser Time Series

Gets the time series for the advertiser identified by the advertiserId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
query Parameters
sort
string
startDate
string
interval
string
endDate
string
agencyId
string

Responses

200

200 response

400

400 response

get/timeseries/advertiser/{advertiserId}
https://api.ad360.media/v1/timeseries/advertiser/{advertiserId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Campaign Time Series

Gets the time series for the campaign identified by the campaignId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
advertiserId
required
string
campaignId
required
string
query Parameters
sort
string
startDate
string
interval
string
endDate
string

Responses

200

200 response

400

400 response

get/timeseries/advertiser/{advertiserId}/campaign/{campaignId}
https://api.ad360.media/v1/timeseries/advertiser/{advertiserId}/campaign/{campaignId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Line Item Time Series

Gets the time series for the line item identified by the lineItemId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
campaignId
required
string
lineItemId
required
string
advertiserId
required
string
query Parameters
sort
string
endDate
string
startDate
string
interval
string

Responses

200

200 response

400

400 response

get/timeseries/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}
https://api.ad360.media/v1/timeseries/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Creative Time Series

Gets the time series for the creative identified by the creativeId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
campaignId
required
string
creativeId
required
string
lineItemId
required
string
advertiserId
required
string
query Parameters
sort
string
endDate
string
startDate
string
interval
string

Responses

200

200 response

400

400 response

get/timeseries/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/creative/{creativeId}
https://api.ad360.media/v1/timeseries/advertiser/{advertiserId}/campaign/{campaignId}/lineitem/{lineItemId}/creative/{creativeId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Get Agency Time Series

Gets the time series for the agency identified by the agencyId passed in the request path.

Authorizations:
CognitoAuth
path Parameters
agencyId
required
string
query Parameters
sort
string
startDate
string
interval
string
endDate
string

Responses

200

200 response

400

400 response

get/timeseries/agency/{agencyId}
https://api.ad360.media/v1/timeseries/agency/{agencyId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }