API Reference
Log In
API Reference

Version History

v3.2.0

released April 21, 2025

Added

  • Webhook signing is now supported. If you opt in, all webhook requests will include an X-Signature header containing a timestamp and HMAC signature. This allows you to verify the authenticity and integrity of incoming webhook payloads. This feature is optional and does not affect existing webhook integrations. By default, no signature will be included unless a webhook secret has been configured. To opt in, please contact support and we will provide a secret key for verifying signatures. See this page for more details.

v3.1.0

released March 11, 2025

Changed

  • The scores objects that are returned with the preflight result now have a boolean field to indicate whether the score is a default score.

v3.0.0

Added

  • Created a GET /dimensions endpoint that allows you to view all the parameters you can use when creating your preflights.
  • Created a GET /healthz endpoint for easy API health monitoring.
  • We are now sending webhooks for all preflight status changes.

Changed

  • Changed the input parameters for the POST /preflights endpoint. One of the more notable changes is that you can now provide an external_label parameter when creating a preflight, which will be saved in our database record returned whenever you retrieve the preflight. You can now also specify the ad format and the content type for the preflight. Please see the endpoint documentation for more details.
  • The GET /preflights endpoint now returns a paginated result. Check the endpoint documentation and our Pagination explainer page for more details about the new functionality.
  • Changed the response body for the GET /preflights/:id endpoint to better match the information our clients are seeking. Please see the endpoint documentation for details.
  • Implemented a function to normalize the errors associated with preflights and assigned error codes for all errors.
  • When returning market information as part of a larger response body, we now return both the market name and the ISO3166 two-letter country code if it exists.
  • When returning brand information as part of a larger response body, we now return both the brand name and our internal brand id for easier reference.

Removed

  • Removed the GET /preflights/:asset_id endpoint.
  • Removed the GET /brandsendpoint. This information now lives in the GET /dimensions\ endpoint

Fixed

  • Added the DELETE /preflights/:id endpoint for preflights, which has been described in our documentation but never implemented.
  • Corrected HTTP response codes for existing endpoints to comply with best practices and provide accurate information about API operations.