Ads

List all the sites with ads configured

get

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

statusstring · enumOptional

Filter sites by their ads review status

Default: in-reviewPossible values:

Header parameters

X-GitBook-Partner-KeystringRequired

Responses

200

OK

application/json

default

Unexpected Error

application/json

get

/ads/sites

HTTPcURLJavaScriptPython

GET /v1/ads/sites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-GitBook-Partner-Key: text
Accept: */*

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

Update the Ads configuration for a site

patch

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

siteIdstringRequired

The unique id of the site

Header parameters

X-GitBook-Partner-KeystringRequired

Body

application/json

or

or

Responses

204

OK

default

Unexpected Error

application/json

patch

/ads/sites/{siteId}

HTTPcURLJavaScriptPython

PATCH /v1/ads/sites/{siteId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-GitBook-Partner-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "status": "live",
  "zoneId": "text",
  "reportingId": "text"
}

No content