Products API

Retrieve your monitored products and their visibility scores.

List Products

GET/api/v1/products

Returns a paginated list of products with their latest visibility scores.

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number
limitinteger50Items per page (max 100)
statusstringactiveFilter by status: active, inactive, all

Response

JSON
{
  "products": [
    {
      "id": "uuid",
      "name": "Nike Air Max 90",
      "description": "Classic sneaker...",
      "url": "https://example.com/air-max-90",
      "image_url": "https://...",
      "status": "active",
      "visibility_score": 72.5,
      "created_at": "2025-01-15T10:30:00Z"
    }
  ],
  "total": 25,
  "page": 1,
  "limit": 50
}

Example

Shell
curl https://your-domain.com/api/v1/products?status=active&limit=10 \
  -H "X-API-Key: apin_your_key_here"

Required scope: read