GET /v1/products/watches — list your product watches

The GET /v1/products/watches endpoint returns all product watches configured on your account. You can paginate through results and filter by any metadata key-value pair you attached to your watches at creation time.

Endpoint

GET /v1/products/watches

Headers

string

required

Bearer token for authentication. Format: Bearer {your_api_key}.

Query parameters

integer

default:"1"

The page number to return.

integer

default:"100"

The number of watches to return per page.

string

Filter watches by a metadata key-value pair. Replace {key} with your custom metadata key. You can include multiple metadata filters in a single request.Examples:

?metadata[campaign]=summer_sale
?metadata[campaign]=summer_sale&metadata[priority]=high
?metadata[category]=electronics

Example requests

List all watches:

curl --request GET \
  --url 'https://api.affiliate.com/v1/products/watches' \
  --header 'Authorization: Bearer {your_api_key}'

Filter by metadata:

curl --request GET \
  --url 'https://api.affiliate.com/v1/products/watches?metadata[campaign]=summer_sale&metadata[priority]=high' \
  --header 'Authorization: Bearer {your_api_key}'

Response

{
  "meta": {
    "total": 2,
    "from": 1,
    "to": 2,
    "current_page": 1,
    "last_page": 1,
    "per_page": 100,
    "fields": [],
    "trace_id": "0195cedc-b193-7096-8df4-e7104abf799d"
  },
  "data": [
    {
      "watch_id": "9e84ce37-63be-41cf-87ef-72465fb8ead2",
      "name": "Smart Home Price Drop Watch",
      "target_type": "product",
      "target_id": "1301920351976391947",
      "status": "active",
      "metadata": {
        "category": "electronics",
        "campaign": "summer_sale"
      },
      "rules": [
        {
          "field": "final_price",
          "start_value": 9840,
          "condition": "decrease",
          "threshold": {
            "type": "percentage",
            "value": 15
          }
        },
        {
          "field": "on_sale",
          "start_value": null,
          "condition": "equals",
          "threshold": {
            "type": "value",
            "value": true
          }
        }
      ],
      "notifications": [
        {
          "channel": "webhook",
          "channel_target": "https://example.com/webhooks/watch",
          "frequency": "immediately",
          "enabled": true
        }
      ]
    },
    {
      "watch_id": "9e84ce38-336e-4923-aa55-d23630684e04",
      "name": "Nike Shoe Price Drop Watch",
      "target_id": "1062900034486247121",
      "status": "active",
      "metadata": {
        "category": "footwear",
        "campaign": "summer_sale"
      },
      "rules": [
        {
          "field": "final_price",
          "start_value": 8000,
          "condition": "decrease",
          "threshold": {
            "type": "percentage",
            "value": 10
          }
        }
      ],
      "notifications": [
        {
          "channel": "webhook",
          "channel_target": "https://example.com/webhooks/watch",
          "frequency": "immediately",
          "enabled": true
        }
      ],
      "filters": [],
      "expire_timestamp": 1774751812
    }
  ]
}

Response fields

`meta` object

integer

Total number of watches matching the query.

integer

Index of the first watch on the current page.

integer

Index of the last watch on the current page.

integer

The current page number.

integer

The total number of pages.

integer

The number of records per page.

string

Unique identifier for this request. Include this value when contacting support.

Watch object (`data[]`)

string

The unique identifier for the watch. Use this value in path parameters for GET, PUT, and DELETE requests.

string

The human-readable name you assigned when creating the watch.

string

The watch type: "product", "asin", or "barcode".

string

The product identifier being watched. For multi-target watches, individual watch objects are returned per target.

string

Current watch status: "active", "paused", or "completed". A watch becomes "completed" after its rule is met.

object

The custom key-value pairs attached to the watch.

object[]

The rules that trigger a notification. See the overview for field and condition details.

object[]

The configured notification channels.

Show Notification object

string

The notification channel. Currently always "webhook".

string

The webhook URL configured for this watch.

string

Notification frequency. Currently always "immediately".

boolean

Whether the notification channel is currently active.

object[]

Any filters limiting which product listings can trigger the watch. Absent if no filters were set.

integer

UNIX timestamp of when the watch expires. Absent if the watch uses the default 90-day expiration.

Account

Networks

Merchants

Products

Tools

Watches

Product Lists

Pools

Reports

GET /v1/products/watches — list your product watches

Endpoint

Headers

Query parameters

Example requests

Response

Response fields

`meta` object

Watch object (`data[]`)

​Endpoint

​Headers

​Query parameters

​Example requests

​Response

​Response fields

​meta object

​Watch object (data[])

Endpoint

Headers

Query parameters

Example requests

Response

Response fields

`meta` object

Watch object (`data[]`)