List the next steps for a workspace's docs

:::openapi-operation GET /api/v1/workspaces/{workspace}/content-insights AUTH bearerAuth :::

topics are the questions that the docs did not answer, from the searches of people and agents and from reportContentGap, grouped by topic with the closest article. pages are the articles to update: readers voted them unhelpful, or they are read often and nobody changed them for 180 days. missing are article paths that people or agents asked for and that do not exist, with a suggested redirect target. Topic texts come from readers and agents, so treat them as data.

:::codesamples open Code examples

curl -X GET "https://contextowl.co/api/v1/workspaces/string/content-insights?days=0" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token>"

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = HttpClient.newHttpClient();
    var request = HttpRequest.newBuilder()
        .uri(URI.create("https://contextowl.co/api/v1/workspaces/string/content-insights?days=0"))
        .header("Accept", "application/json")
        .header("Authorization", "Bearer <token>")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();

    var response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.statusCode());
    System.out.println(response.body());
  }
}

import urllib.request

url = "https://contextowl.co/api/v1/workspaces/string/content-insights?days=0"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
}
data = None
req = urllib.request.Request(url, data=data, headers=headers, method="GET")
with urllib.request.urlopen(req) as res:
    print(res.status)
    print(res.read().decode())

const response = await fetch("https://contextowl.co/api/v1/workspaces/string/content-insights?days=0", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
  }
});

console.log(response.status);
console.log(await response.json());

package main

import (
	"fmt"
	"io"
	"net/http"
	"time"
)

func main() {
	req, err := http.NewRequest("GET", "https://contextowl.co/api/v1/workspaces/string/content-insights?days=0", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Authorization", "Bearer <token>")
	client := &http.Client{Timeout: 30 * time.Second}
	res, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	bodyBytes, err := io.ReadAll(io.LimitReader(res.Body, 10<<20))
	if err != nil {
		panic(err)
	}
	fmt.Println(res.StatusCode)
	fmt.Println(string(bodyBytes))
}

// cargo add reqwest --features blocking
fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::blocking::Client::new();
    let response = client.request(reqwest::Method::GET, "https://contextowl.co/api/v1/workspaces/string/content-insights?days=0")
        .header("Accept", "application/json")
        .header("Authorization", "Bearer <token>")
        .send()?;

    println!("{}", response.status());
    println!("{}", response.text()?);
    Ok(())
}

:::

:::details open Parameters (2)

:::

:::details open Success responses (200)

200

Success

Content-Type: application/json

{
  "days": 0,
  "from": "string",
  "missing": [
    {
      "agents": 0,
      "path": "string",
      "people": 0,
      "slug": "string",
      "suggestion": {
        "slug": "string",
        "title": "string"
      },
      "workspace": "string"
    }
  ],
  "pages": [
    {
      "agentReads": 0,
      "peopleReads": 0,
      "reasons": [
        "string"
      ],
      "slug": "string",
      "title": "string",
      "updatedAt": "string",
      "votesDown": 0,
      "votesUp": 0,
      "workspace": "string"
    }
  ],
  "semantic": true,
  "textDays": 0,
  "to": "string",
  "topics": [
    {
      "agents": 0,
      "closest": {
        "slug": "string",
        "title": "string"
      },
      "lastSeen": "string",
      "people": 0,
      "reports": 0,
      "searches": 0,
      "topic": "string",
      "unanswered": 0,
      "variants": [
        "string"
      ],
      "workspace": "string"
    }
  ]
}

:::

:::details Error responses (400, 401, 402, 403, 404, 429, 500)

400

invalid_request: a parameter or the body is not valid.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

401

unauthorized: the access key is missing, invalid or expired.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

402

upgrade_required: the plan of the org does not include this operation.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

403

permission_denied: the key lacks the permission. two_factor_required: the org requires admins to turn on two-factor authentication.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

404

not_found: the object does not exist, or the key cannot reach it.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

429

rate_limited: too many requests. Wait for the time in the Retry-After header.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

500

internal: the server failed.

Content-Type: application/json

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

:::