Analytics v1 API Deprecation

On the 22nd of November 2021, we will be retiring the Analytics v1 endpoint from Netlify’s API.

Neltify’s Analytics dashboard was updated to use the new v2 endpoint on October 27 2021. Details about this change can be found here.

The vast majority of users - those that access your analytics data via the Analytics dashboard in the Netlify app - will not be affected by this change. Your analytics will not break or stop collecting data. However, if you are accessing Netlify’s v1 Analytics endpoint directly, for example through an API, then this deprecation will affect you.

Over the next few weeks, we will be preparing for the deprecation by periodically disabling the v1 service to check for issues. A full list of important dates as we approach deprecation are as follows:

  • Oct 27, 2021 - v2 endpoint enabled in the Analytics dashboard for all customers. - DONE
  • Nov 9, 2021 - 1-hour v1 endpoints brownout during the day. Any requests to v1 endpoints during that hour will return a 404 with a descriptive message. - DONE
  • Nov 16, 2021 - Stop hourly updates to v1 endpoints and backfills for new sites. V1 endpoints will still return data up to this date. - DONE
  • Nov 17, 2021 - Full day v1 endpoints brownout. Any requests to v1 endpoints during that day will return a 404 with a descriptive message. - DONE
  • Nov 22, 2021 - Deprecate v1 endpoints. Any v1 request after this day will return a 404. - DONE

We will announce any changes to the above dates within this thread.

If you have any follow-up questions or feedback, please share them in the thread below.

1 Like

Very simple question - will v2 be documented? v1 never was - and as someone who used it anyway I appreciate the warning - but can we get confirmation that v2 will be documented and “safe” to use?

Also, will v2 support fetching data older than 30 days?

1 Like

Hi @cfjedimaster, thanks for the questions!

For the time being, we’re treating V2 similar to V1 - that is: no documentation and 30 days retention. We don’t have any immediate plans to change that.

We notified about the deprecation of V1 since we noticed several people accessing it directly, so we wanted to avoid surprises. While not documented, V2 is very similar to V1 and migration should be seamless if you decide to do so. But again we can’t provide any documentation nor commitment to not changing existing endpoints at the moment.

If we decide to document V2, we will be posting here in the forums since it has been a pretty requested feature.

2 Likes

Thanks for the reply. Can I ask why the long delay in deciding if the API will be documented? If it’s a business decision to not document it that’s totally fine, that’s a firm answer at least.

At the moment it’s a matter of prioritization. Putting public documentation for the API has some implications besides writing and putting the documentation online, we need to maintain compatibility, communicate any changes, etc. Since Analytics not a “core” API we reserved ourselves the right to keep it undocumented to work on some underlying changes to analytics more easily.

2 Likes

Fair enough - thanks!

1 Like

Quick update on progress.

  • Due to issues that arose with data ingestion, we had to move up our date to stop hourly updates to v1 endpoints and backfills. This process was ended today (Nov 16). Therefore, only data up to November 16 2021 will be available via the v1 endpoint and no new data will be ingested.
  • The full day v1 endpoints brownout that was scheduled for today has been postponed until tomorrow (Nov 17).

Thank you for your understanding. More updates as available.

2 Likes

Quick update: The full-day v1 endpoints brownout has been started.

[EDIT] and completed

1 Like

Final update: v1 endpoints are officially deprecated. All requests made to the v1 endpoints after today will return a 404.

1 Like