Ads

Manage advertisement settings and placements.

Update the Ads configuration for a site

patch

/ads/sites/{siteId}

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Path parameters

siteIdstringrequired

The unique id of the site

Header parameters

X-GitBook-Partner-Keystringrequired

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.gitbook.com/v1/ads/sites/{siteId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'X-GitBook-Partner-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "zoneId": "text",
    "reportingId": "text",
    "status": "live"
  }'

204

default

204

No body

OK

List all the sites with ads configured

get

/ads/sites

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

statusstring · enum · default: in-review

Filter sites by their ads review status

Options: in-review, live, rejected

Header parameters

X-GitBook-Partner-Keystringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/ads/sites' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'X-GitBook-Partner-Key: text'

200

default

200

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "id": "text",
      "url": "text",
      "email": "text",
      "topic": "webdev",
      "status": "in-review"
    }
  ]
}

OK