v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB

webdbs

List collections

Returns your WebDB collections.

get/webdbs/collections

Query parameters

limitinteger

Maximum items to return. Defaults to 25.

cursorstring

Pagination cursor from a previous response.

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

[
  "production",
  "team-alpha"
]

Response

A paginated list of collections

has_moreboolean required

Whether another page is available.

next_cursorstring nullable required

Cursor for the next page, or null at the end.

Example response

{
  "data": [
    {
      "id": "col_123",
      "schema": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Product name."
          },
          "price": {
            "type": "number",
            "description": "Current price."
          }
        },
        "required": [
          "title"
        ],
        "additionalProperties": false
      },
      "eligibility": {
        "prefilter": {
          "url_match": [
            "https://shop.com/products/:product_id",
            "https://foo.com/item?id=*",
            "https://foo.com/bar/*",
            "**/events/**"
          ]
        }
      },
      "targets": [
        {
          "id": "tgt_123",
          "sync": {
            "every": "6h"
          },
          "eligibility": {
            "prefilter": {
              "url_match": [
                "https://shop.com/products/:product_id",
                "https://foo.com/item?id=*",
                "https://foo.com/bar/*",
                "**/events/**"
              ]
            }
          }
        }
      ],
      "sync": {
        "every": "6h"
      }
    }
  ]
}