Skip to main content
GET
Get Shopping Product

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Path Parameters

id
string<uuid>
required

Shopping product identifier

Response

Default Response

id
string<uuid>
required

Product identifier

source
string
required

Answer engine the product was extracted from

foreignId
string
required

Product identifier in the source answer engine

title
string
required

Product title

createdAt
string<date-time>
required

When the product was first extracted

updatedAt
string<date-time>
required

When the product was last updated

appearanceCount
integer
required

Number of appearances in AI responses

promptCount
integer
required

Number of distinct prompts the product appeared for

averagePosition
number | null
required

Average 0-based position across appearances

latestAppearance
object | null
required

Most recent appearance of the product, or null