read

Returns ad performance data aggregated over a time window. Includes totals (revenue, ad spend, ROAS as shop revenue over

Returns ad performance data aggregated over a time window. Includes totals (revenue, ad spend, ROAS as shop revenue over ad spend and null without spend, conversion rate, sessions), top 5 performing products, up to 5 underperformers, and a daily trend array. Optionally filter to a single product by product_id.

post/api/v1/tools/query_performance

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/query_performance
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: analytics:read)

Request body

window_daysinteger

Number of days to look back (default 7, max 90).

product_idstring

Optional UUID to scope results to a single product.

Response

Tool result

okboolean required
resultunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.