Site ads
Control and customize ad placements on your docs site.
Was this helpful?
Control and customize ad placements on your docs site.
Was this helpful?
Was this helpful?
Manage the advertisement strategy within your docs. You can specify ad placements, track usage, and adjust settings to best fit your organization's needs.
Identifier of the page results to fetch.
The number of results per page
Filter sites by their ads review status
in-reviewPossible values: OK
OK
OK
No content
No content
POST /v1/orgs/{organizationId}/sites/{siteId}/ads HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"status": "in-review",
"topic": "webdev"
}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"
}
]
}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"
}