New API versions are introduced whenever a feature requires a backward-incompatible change. Upgrading as soon as possible is recommended. We will remove API versions 12 months after its successor is made available. Backwards-compatible features are tentatively implemented in previous versions as well. This guide provides insight on migrating to new versions.
Deprecation dates
- v1.4: Current version
- v1.3: Supported until 2019-03-09
v1.2:Removed on 2018-01-27v1.1:Removed on 2016-10-25v1.0:Removed on 2016-10-25
1.3 > 1.4
Paths
- Forecast
- Synchronous forecasts are no longer supported.
- Added a DELETE endpoint to delete and cancel all forecasts.
Models
- ForecastRequest
- Warnings no longer show the causes by default.
- The warning level can be set using the
warnings
field.
1.2 > 1.3
Paths
- Targeting
- New endpoint / supporting GET, PUT, DELETE
- New endpoint /{id} supporting GET, POST, PUT, DELETE
Models
- PercentileResult
- The forecast responses are now self-contained. Campaign results have become a map
campaignId
→CampaignPercentileResult
, removing the need to get the campaign order from the request in order to evaluate the results.
- The forecast responses are now self-contained. Campaign results have become a map
- TargetingRuleContainer
- The container can now either define a rule or reference an existing rule by its id
1.1 > 1.2
Models
- GroupedCampaignForecast
- The keys of forecasts with
groupBy
’s are now grouped by a key-value map instead of a value array
- The keys of forecasts with
- ForecastResult
- The campaign results are now a
campaignId
→CampaignForecastValues
map
- The campaign results are now a
Responses
- General
- All responses (except 404 errors) are now formatted as
application/json
- All responses (except 404 errors) are now formatted as
1.0 > 1.1
Paths
- Campaigns
- The POST method was removed;
- The existing PUT method semantics changed (it now has the same semantics as the POST method had)
- There are new endpoints to manage campaigns singularly
- Frequency Groups
- The POST method was removed;
- The existing PUT method semantics changed (it now has the same semantics as the POST method had)
- There are new endpoints to manage frequency groups singularly
- Hints
- New endpoint / supporting GET, PUT, DELETE
- New endpoint /{id} supporting GET, POST, PUT, DELETE
- Forecast
- There’s a new endpoint to get results of the existing campaigns
Models
- FrequencyGroup
- An
id
field was added
- An
- ForecasterHint
- ForecastRequest
- There’s a new
existingCampaignsOverrides
field to allow overriding fields of existing campaigns
- There’s a new