What's happening?
StackAdapt is sunsetting their REST API by the end of 2025, in favour of their new GraphQL-powered API. In preparation for this, we have upgraded our connector to support the new API, and any newly-connected data sources will use the GraphQL API to retrieve data.
What happens to existing data sources?
We have developed our new connector to allow old and new data sources to run in parallell. To migrate an existing data source to use StackAdapt's new API, it just needs to be reconnected using a GraphQL API key.
To avoid service interruption, you will need to reconnect all of your existing StackAdapt data sources before the old API shuts down around the end of 2025.
To receive a GraphQL API key, reach out to the StackAdapt team and they will generate one for you.
Are there any compatibility issues between the old/new APIs?
Yes. While the vast majority of fields will function exactly the same between both APIs, there are a few exceptions and caveats which may affect you, depending on what report types and breakdowns your data sources use.
All the changes that we have observed from our own testing are outlined in the table at the bottom of this FAQ, but please be aware that this table may not be exhaustive. We will update the table with any changes we come across.
I am noticing issues after reconnecting my data sources, what should I do?
First, make sure that your issue is not already explained in the table below.
If it is not, please reach out to the Funnel support team through the in-app support chat and describe what problem you are experiencing. Your inquiry will then be passed on to a developer for further investigation.
Differences between the old and new StackAdapt APIs
We've listed all the changes between the old and the new API that we're currently aware of, but there could be more that we haven't been able to test yet.
Change | Explanation |
Changes to the output values of the Campaign type field | In the old API, Campaign type would contain values like
In the new API, this field is a combination of Campaign type and Channel, yielding values like
If you have any custom fields that depend on either Campaign type or Channel, please make sure to edit those accordingly after migrating. |
Deprecation of the Channel field | Given the changes to the Campaign Type field outlined above, and since Channel is not available in the new API, this field will be deprecated. |
Using the Conversion tracker breakdown yields different metric totals | When we query the old API for conversion tracker metrics, we first collect a list of all unique conversion trackers for the campaigns belonging to the advertiser, then query these one-by-one through the delivery endpoint.
The new API has a dedicated method for getting this conversion tracker data, which appears to function differently from the method we used for the old API. We assume that these new numbers are more accurate, but just be aware that they will differ between the old and new APIs. |
The Conversion tracker breakdown is now considered an Insight report, not Delivery | The new API returns conversion tracker data through an Insight report, whereas the old API offered it as part of their Delivery reports. As a result, the definition label for conversion tracker data sources will change as follows.
Old:
New:
Additionally, some new fields will be available to conversion tracker data sources, most notably Campaign and Campaign group. |
The values for the Audience dimension are different | The new API returns slightly different values for Audience data. The values are different depending on your audience, but generally speaking Prefixes and Suffixes seem to have been removed. Here are some examples: |