Guides
Changelog
Changes to the API, newest first. Each change added an endpoint, field, header or query parameter, so clients written against an earlier version keep working.
- Errors from
POST /orders,POST /spendandPOST /viewsnow carrydetail, as the export endpoints' errors do, with the same sentence thaterrorstill carries. A 500 from them has that body instead of an empty one. See Errors.
- Failed
POST /ordersandPOST /spendrequests made with a valid key are kept for 30 days and listed under Settings > Data Diagnostics. Their error responses carry the record's id inX-Request-Id. - 331 of the 537 metrics now carry data, up from 216. The platform-reported columns, such as Meta's website purchases, had been exporting empty.
- Partner views: Shopify order ids of the form
gid://shopify/OrderIdentity/…are read as the order number, asgid://shopify/Order/…already was. - A model or window that a brand switches off keeps the rows computed while it was on, until they are recomputed. The warning in the export result now says so.
- New:
POST /viewstakes ad views a partner has matched to orders, for Clicks + Deterministic Views. It needs the newviews:writescope, which a key gets only when someone ticks it. Orders sent toPOST /orderswithcustomer_emailorhashed_customer_emailcan now be matched to views by email; the address is not stored. - New:
GET /exports/accountreturns the key's brand, time zone, currency, lookback, enabled models and windows, and the key's own scopes. - API keys have scopes:
export:read,orders:writeandspend:write, with the short namesexport,ordersandspend. A key created without a scope list gets all three, as before. GET /exports/attribution-models?include_disabled=truelists every model with anenabledflag. The default answer is unchanged.- Export results add
rows,filesandcolumns, and downloads sendX-Row-Count,X-File-IndexandX-File-Count. - Export files are planned when the export is processed: whole days packed into files of at most 25,000 lines, never two calendar months in one daily file, and a day too large for one file split into parts. See Files and pagination.
- Clicks + Deterministic Views and Clicks + Modeled Views can be exported.
- New:
POST /ordersfor orders from stores that are not on Shopify, andPOST /spendfor daily spend from platforms MTA has no connector for. - New: the data export API.
GET /exports/attribution-models,/exports/metricsand/exports/breakdowns;POST /exports/data-export; results with signed links that work for an hour; CSV downloads. A period of up to 31 days is processed inside the request. Each key may create 60 exports a minute. Writing to a GCS or S3 bucket is refused. - New: API keys per brand, sent in
Authorizationwith the brand id inData-Client-ID. A key is shown once and stored only as a hash.
Questions about the API: support@growthdept.ai.