This guide will provide the right tools to understand the migration from API 1.0 (v1) to 2.0 (v2) and ultimately, 3.0 (v3). Please keep in mind that this isn’t a glossary of metrics; therefore, it doesn’t include all the metrics in the Socialbakers API. (It also doesn’t include all the new metrics, only the metrics that had to be migrated from the previous version.)
You can find all metrics available in the Socialbakers API, in the documentation here. Just make sure you’re checking the latest and most recent documentation (v3). Simply select the version at the top-right corner in the introduction of the API documentation:
How to Read This Guide
In this guide, you will find 5 tables, each with a different social media platform (Facebook, Instagram, Twitter, Youtube and Pinterest). Each table shows:
- The old names of metrics (version 1.0) - The names of the metrics as found in the API v1;
- The new names of metrics (3.0) - On version 2.0, new names were given to most of the metrics (presented in the tables below) due to a better arrangement of the metrics in the API documentation.
- New dimensions (3.0) - A whole new set of dimensions has been introduced in the API v2. Previously (v1), the aggregated post metrics were aggregated per day (date.day), but now you can choose between a whole new set. Check the example below:
- New sections (3.0) - At which section of the 3.0 (and 2.0) documentation you can find the metric. New sections have been introduced.
- New API Metrics - Content Hub metrics were introduced with v3. Check this guide.
Let's take the example of the first two metrics in the Facebook Table below: number_of_comments (new name).
In version 1.0, both metrics had different names (comments & comments_by_type). In version 3.0 (and 2.0), both have the same name number_of_comments but to differentiate between them, and to aggregate the comments by their type, it is necessary to include the media_type on top of the other requested dimension. Check the documentation for a better understanding.
Why All New Dimensions are Not Included in the Boards Below:
For each table below, the results presented show you how to obtain the same results as in v1. So, to get the aggregation of comments per day, you need to use the dimension date.day.
If you want to know how to get started with the Socialbakers API, check out the article here.