read

Compare aggregate performance between two adjacent time windows. Returns revenue, orders, spend, ROAS, and conversion-ra

Compare aggregate performance between two adjacent time windows. Returns revenue, orders, spend, ROAS, and conversion-rate totals for the current period and the prior period of equal length, plus deltas. Window options: "week" (last 7d vs 7d before), "month" (30d vs 30d), "custom" (caller supplies days).

post/api/v1/tools/compare_periods

Request

  • Base URL: https://app.magistry.io
  • URL: https://app.magistry.io/api/v1/tools/compare_periods
  • 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'week' | 'month' | 'custom'

Length of each comparison period. Default: week.

daysinteger

Period length in days when window === "custom".

Response

Tool result

okboolean required
resultunknown required

Changes

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