Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.

Query Parameters

merchant_id
string
required

Lite merchant id, e.g. shopify-<shop id>.

id_token
string

App Bridge session token, when not sent as a bearer header.

Response

The report.

has_run_at_least_one_ingestion
boolean
required
completion_percentage
number
required

0–100: the ingestion state as a share of ready-for-use.

ingestion_state_description
string
required
first_data_at
string | null
required

ISO instant of the shop's earliest real search, or null before any. Compare periods only once a full previous period lies after it.