resources

List a site's pages

The pages of a site resource, sorted by address, with their state and why a page failed when it did. counts covers every page of the site; filter with status (for instance failed) and paginate with cursor. Up to 5,000 pages.

GET/v1/resources/{resource_id}/pages

Request

curl --request GET \
  --url 'https://api.lookio.app/v1/resources/<resource_id>/pages' \
  --header 'Authorization: <api-key>'

import json
import requests

url = "https://api.lookio.app/v1/resources/<resource_id>/pages"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://api.lookio.app/v1/resources/<resource_id>/pages", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.lookio.app/v1/resources/<resource_id>/pages");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://api.lookio.app/v1/resources/<resource_id>/pages", nil)
  req.Header.Set("Authorization", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

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

var request = HttpRequest.newBuilder(URI.create("https://api.lookio.app/v1/resources/<resource_id>/pages"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.lookio.app/v1/resources/<resource_id>/pages")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "url": null,
    "last_synced_at": null,
    "counts": {
      "ready": 123,
      "busy": 123,
      "failed": 123
    },
    "pages": [
      {
        "id": "<string>",
        "url": null,
        "title": null,
        "status": "<string>",
        "detail": null,
        "missing": 123,
        "updated_at": "<string>"
      }
    ],
    "has_more": true,
    "next_cursor": null
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

Requires resources:read.

Pages come sorted by address. counts covers every page of the site, whatever the filter. Filter with status (ready, busy or failed) and pass next_cursor back as cursor while there are more. The list holds up to 5,000 pages.

Use it to find out why a site imported fewer pages than expected. Read the detail of a failed page, then retry the failed pages.

Authorizations

Authorizationbearerin headerrequired

Path parameters

resource_idstringrequiredpattern: ^res_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

Query parameters

limitintegerrange: 1–100

Number of items to return. Values outside 1-100 are clamped, and the response reports the limit actually applied.

cursorstringpattern: ^doc_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

Pass next_cursor from the previous page, unchanged.

statusenum<string>one of: ready, busy, failed

Only pages in this state. busy is every page being read.

Response

application/json

List a site's pages

dataobjectrequired

Show child attributes

data.urlstringnullrequired

data.last_synced_atstringnullrequired

data.countsobjectrequired

Over every page of the site, whatever the filter.

Show child attributes

data.counts.readyintegerrequired

data.counts.busyintegerrequired

data.counts.failedintegerrequired

data.pagesobject[]required

One page of the site's pages, sorted by address.

Show child attributes

data.pages.idstringrequiredpattern: ^doc_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

data.pages.urlstringnullrequired

data.pages.titlestringnullrequired

data.pages.statusstringrequired

data.pages.detailstringnullrequired

Why a page could not be read, when it failed.

data.pages.missingintegerrequired

Consecutive syncs where the page was absent. A page absent twice is removed.

data.pages.updated_atstringrequired

data.has_morebooleanrequired

data.next_cursorstringnullrequired

request_idstringrequired

{ "data": { "url": null, "last_synced_at": null, "counts": { "ready": 123, "busy": 123, "failed": 123 }, "pages": [ { "id": "<string>", "url": null, "title": null, "status": "<string>", "detail": null, "missing": 123, "updated_at": "<string>" } ], "has_more": true, "next_cursor": null }, "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>" }, "request_id": "<string>" }

List a site's pages

Authorizations

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown