Owned content#

The parts of your own site you publish to bring people in, such as a blog, guides or a free tool. Each is defined by URL paths and measured as a whole: how often it shows in Google search, the clicks it gets, the visits that start on it, and the success metric and interest actions in those visits.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/owned-content#

List the owned content on your site, such as a blog or guides section, with the URL paths that define each one, its job and when it started.

bash

GET /v1/owned-content?workspace_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
workspaceId	`string (UUID)`	Required	Workspace identifier.

Response#

Returns { items, totalCount, facets, _meta } with paginated results.

GET /v1/owned-content/performance#

Retrieve how each piece of owned content did, month by month: Google search impressions and clicks for its pages, clicks from searches that named your brand, visits that started on it, and the success metric and interest actions in those visits. Search Console leaves rare searches out of query-level figures, so branded clicks are a lower bound, and success metric counts from GA4 are a rough guide. 12 calendar months by default (3-24).

bash

GET /v1/owned-content/performance?workspace_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01&end_date=...
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
workspaceId	`string (UUID)`	Required	Workspace identifier.
endDate	`string`	Required	Last day to include (YYYY-MM-DD), usually today. Months run to the end of this date’s month.
months	`integer`	—	Calendar months to return, oldest first (3-24, default 12).

Response#

Returns { data, _meta } with the result.

POST /v1/owned-content#

Add a part of your own site to track as owned content, such as a blog at /blog, by name and URL paths. Its job is Be findable unless you choose another. Search and visit history is fetched automatically.

bash

POST /v1/owned-content
Authorization: Bearer {token}
Content-Type: application/json

{
  "workspace_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "name": "My Campaign",
  "paths": "..."
}

Parameters#

Name	Type	Required	Description
workspaceId	`string (UUID)`	Required	Workspace identifier.
name	`string`	Required	What you call this content, such as "Blog" or "Help centre".
paths	`Array<string>`	Required	The paths that make up this content, such as ["/blog", "/guides"].
job	`'build' \| 'findable' \| 'convert'`	—	Its job. Be findable (findable) unless you say otherwise.
runningSince	`string \| null`	—	When you started publishing it (YYYY-MM-DD), or null when you are not sure.

Response#

Returns { data, _meta } with the result.

PATCH /v1/owned-content/:id#

Update owned content's name, URL paths, job or start date. Changing the paths fetches its search and visit history again.

bash

PATCH /v1/owned-content/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
id	`string (UUID)`	Required	Unique identifier (UUID v4).
name	`string`	—	What you call this content, such as "Blog" or "Help centre".
paths	`Array<string>`	—	Replaces every path. Changing them refetches the content’s search and visit history.
job	`'build' \| 'findable' \| 'convert'`	—	build: more of the right people know and remember you, judged by interest over months (TV, radio, outdoor, PR, your own posts). findable: you show up when someone looks for what you do (content, listings, review sites, backlinks). convert: nudges people who already know you, judged by direct evidence within weeks (paid media, in-person events, partnerships, offers).
runningSince	`string \| null`	—	When you started publishing it (YYYY-MM-DD), or null when you are not sure.

Response#

Returns { data, _meta } with the result.

DELETE /v1/owned-content/:id#

Remove a part of your site from owned content so Brandwave stops tracking it.

bash

DELETE /v1/owned-content/:id
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
id	`string (UUID)`	Required	Unique identifier (UUID v4).

Response#

Returns { data, _meta } with the result.