Sign in

v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Create Site

This API call adds a new site to the network. The result includes the unique "Site ID" that can be used to update or remove the site.

By default, all new sites are mapped to the All Sites channel. If the All Sites channel is deleted or the site is removed from that channel, the site must be mapped to another channel to be used in ad requests.

post/v1/site

Request body

Titlestring required

The site's name

URLstring required

The new site's link. Must be in the format https://path of URL

NetworkMarginnumber float

Sets a network margin for a site in a network. The network margin adjusts the price a site bids at in auctions but not its revenue in reporting

CustomRelevancyScoreinteger

The site's relevancy score, an integer between 1 and 1000. The lower the relevancy score, the lower the ad will be ranked in the auction. A site that does not have a defined relevancy score will have a default relevancy score of 500. Learn more.

IsDeletedboolean

Don't use when creating a Site. Defaults to false

Response

200

Idinteger
Titlestring
Urlstring
{"stackTrail":"paths:/v1/site:post:responses:200:content:application/json:schema:properties:NetworkMargin","oasType":"schema","type":"unknown"}
PublisherAccountIdinteger
IsDeletedboolean

Example response

{
  "Id": 12345,
  "Title": "Your Site Name",
  "Url": "http://www.example.com",
  "PublisherAccountId": 1234
}