Skip to main content
GET
Get a product's where-to-buy click summary

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization that owns the product.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string<gtin>
required

GTIN-8/12/13/14 of the product. Normalized to GTIN-14 by zero-padding before lookup.

Required string length: 8 - 14
Pattern: ^[0-9]{8}$|^[0-9]{12,14}$

Response

OK

Clicks through to where-to-buy and branded pages for a product.

this_month
integer
required

Clicks this calendar month.

Required range: x >= 0
Example:

40

all_time
integer
required

Clicks on record.

Required range: x >= 0
Example:

910

first_click_month
string<date-time> | null

Month of the first recorded click; null when none.