COcontext
webdbs

List collections

Changed on

Returns your WebDB collections.

get/webdbs/collections

Request

  • Base URL
    https://api.context.dev/v1
  • URL
    https://api.context.dev/v1/webdbs/collections
  • Auth
    HTTP bearer

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"
      }
    }
  ]
}

Changes

  • 182f532c2552Revision changes
    • warning

      added the new WEBSITE_BLOCKED enum value to the response property for the response status

  • 3c6a01ba967fRevision changes
    • warning

      added the new COLD_DOMAIN_TIMEOUT_TOO_LOW enum value to the response property for the response status