Operation details
#key is a product's key from the report. Returns its attribution and up to 100 appearances in the window, newest first, with position, price, retailer and link. Topics filter as in the report. Returns 404 when the product has no appearance in the window and topics.
Authentication and scopes
#Send your workspace API key in the Authorization: Bearer YOUR_API_KEY header. This operation requires read.
See Authentication for key setup and project access.
Path parameters
#| Parameter | Type | Requirement | Details |
|---|---|---|---|
projectId | string | Required | Format: uuid. |
Query parameters
#| Parameter | Type | Requirement | Details |
|---|---|---|---|
key | string | Required | See the complete schema for nested fields and alternatives. |
from | string | Required | Pattern: ^\d{4}-\d{2}-\d{2}$. |
to | string | Required | Pattern: ^\d{4}-\d{2}-\d{2}$. |
topics | array of string | Optional | Minimum items: 1. Maximum items: 100.Parameter schema |
Array query values use comma-separated values. Cross-field rules and date-window checks are also enforced by the API. See Pagination and filters.
Response envelope
#Successful JSON responses return the operation’s result under data and a request identifier under meta.requestId. Collection results include their own pagination or coverage metadata. The payload inside data varies by operation.
The OpenAPI document defines shared success and error envelopes. It does not define every operation’s returned data fields or promise that every operation returns every listed success status. See the request and response guide and workflow examples for documented payloads.
Errors and retries
#Check the HTTP status and stable error.code. Keep meta.requestId when investigating a failed request. Follow Retry-After when it is present, and check existing job or resource state before retrying a write.
See Errors and limits for validation, permissions, conflicts, and temporary queue denials.