Update: Deadline was extended to March 15, 2019

Hey everyone!

Just a heads up that the LinkedIn Company Pages API is in the process of deprecating v1 and migrating to v2. API requests using v1 of the LinkedIn Company Pages API will no longer be supported after March 15, 2019. We will be performing our migration, to support LinkedIn Company Pages API v2, before  March 15, 2019. For more detailed information and to find out what you need to do, please visit the LinkedIn migration guide.

LinkedIn API migration - What’s changing and what do I need to do?

The LinkedIn Company Pages API is being updated. there are two major changes that could affect you and your data sources:

• Changes to syntax
• Changes to JSON output structure

1. Changes to syntax

The syntax in API requests is changing. For example, in v1, a query to get the number of followers would look like this:

• https://api.linkedin.com/v1/companies/<your_company_id>/num-followers?format=json

In v2, it will look like this:

• https://api.linkedin.com/v2/networkSizes/urn:li:organization:<your_company_id>?edgeType=CompanyFollowedByMember

Action required

As a result of the changed syntax, you will need to reconfigure your existing data sources and update the api queries to reflect v2 syntax. For a detailed guide on mapping from v1 to v2 syntax, please visit the LinkedIn migration guide. Please note that some v1 fields are not available in v2.

2. Changes to JSON output structure

The JSON output structure is changing from v1 to v2. For example, in v1, a query to get the number of followers has the following JSON output (shown in a modelled datasource formula):

In v2, the JSON output would look like this (shown in a modelled datasource formula):

Action required

Due to the changes to JSON output structure, you will need to to edit the JSON path (also called XPath) for your existing LinkedIn modelled data sources and Klip formulas.

To help you make these changes, we’ve included a number of scenarios and solutions below.

Scenario #1

You’ve created datasources using LinkedIn data source templates (and you have not customized the query).

After we migrate the API queries for our LinkedIn data source templates to v2, all newly created data sources will reflect the new LinkedIn API version. To update your existing LinkedIn data sources, you will need to reconfigure them (using the method outlined below) for our migration to take effect.

To reconfigure your LinkedIn data sources:

1. In the left navigation bar, click Data Sources.
2. From your list of unmodelled data sources, select the LinkedIn data source you want to reconfigure.
3. Click General and, at Connection, click Reconfigure Connection.
4. Authenticate with your LinkedIn account.
5. On the Configure Data Source page, at Basic settings (Recommended), make the appropriate choice(s) from the drop-down list(s), click on the Submit button and continue to save your data source.

Now that you’ve saved your data source with the new API query, the JSON output structure will be different. You will need to edit any modelled data sources and Klip formulas that use the modified data source to repoint to the correct JSON path selection within the new output.

To update your LinkedIn modelled data source(s):

1. In the left navigation bar, click Data Sources.
2. From your list of data sources, select the modelled data source you want to update.
3. Click General and, at Format, click Edit Model (BETA).
4. Double-click the relevant column to access its formula.
5. Modify the formula to reflect the new JSON output structure by repointing the formula of the modelled data source to the relevant file in the raw data source.
6. Click Save and Exit.

To update your LinkedIn Klip(s):

1. From your datasource, click Associated Klips. If you used a modelled datasource, in the left navigation bar, click Klips.
2. From your list of Klips, select the Klip you want to update.
3. Click General and, at Preview, click Edit Klip.
4. In the Klip Editor, modify the formula to reflect the new JSON output structure by repointing the formula to the relevant file in the raw data source.
5. Click Save.

For detailed information on working with JSON data sources, see this Knowledge Base article.

Scenario #2

You’ve created LinkedIn data sources with customized queries and you’ve used them in modelled data sources or Klip formulas.

Note: You end up with a customized query when you build a custom LinkedIn data source or when you start with a pre-built LinkedIn data source but then switch from Basic to Custom settings and modify the query.

In such cases, you need to manually migrate your v1 query syntax to v2 query syntax.

To migrate your LinkedIn v1 query syntax to v2 query syntax:

1. In the left navigation bar, click Data Sources.
2. From your list of unmodelled data sources, select the LinkedIn data source you want to reconfigure.
3. Click General and, at Connection, click Reconfigure Connection.
4. Authenticate with your LinkedIn account.
5. When you’re directed to the reconfiguration screen (see below), replace the v1 syntax with v2 syntax using the instructions given in the LinkedIn migration guide.
   
   
6. Click Submit, verify your data, and proceed to Save the data source.
7. As with Scenario # 1, please edit all of your modelled data sources and Klip formulas that use the updated data source to ensure that your JSON path selection reflects the v2 output structure.

Note: You can now find the klips associated with a datasource by clicking Associated Klips from the About this Data Source page.

Scenario #3

You’ve added LinkedIn Klip templates (from the Klip Gallery) and have not customized the Klips.

We will be migrating our LinkedIn Klip templates incrementally to reflect v2 changes. To enable migration changes to take place, you need to reconfigure your existing Klips (using the method outlined below).

To reconfigure your existing LinkedIn Klips:

1. With the dashboard open, click the 3-dot menu for the Klip you want to reconfigure and select Reconfigure.
2. Authenticate with your LinkedIn account and select the relevant company page.
3. Click Update Klip.
4. Click Finished.

Please stay tuned for further information as we update our LinkedIn Klip Gallery items (please refer to comments below for updates).

Scenario #4

You’ve added LinkedIn Klip templates (from the Klip Gallery) and have customized the Klips, the associated LinkedIn data source, or both.

To reconfigure your existing customized LinkedIn Klips:

• Either follow the instructions as detailed in Scenario #2 (reconfigure the data source associated with the Klip, change the API request from v1 to v2 syntax, and save the updated data source. Then, update the JSON path selection in the Klip formula in the Klip Editor).

OR

• Add the new version of the Klip templates from our Klip Gallery (if the updated version is available). The data source(s) associated with the new Klip template will contain the new query structure and JSON output structure. If needed, modify the parameters for the data source query and add the customization elements for the Klip, to match its previous design.

Scenario #5

You’ve created customized LinkedIn metrics using a customized LinkedIn data source.

Refer to the Scenario #2 instructions (above) to reconfigure your existing LinkedIn metrics:

1. Reconfigure the underlying data sources,change the API request from v1 to v2, and save the modified data source.
2. Modify the formula of the modelled data source to reflect the new JSON output structure.
3. Check your metrics to ensure they are working as expected.
   
   

Scenario #6

You’ve added a pre-built LinkedIn metric from the Metric Hub and have not customized it.

1. Please note that due to the changes between v1 and v2 api structure, we are unable to migrate pre-built LinkedIn metrics from the Metric Hub.
   
   
2. We have now created new pre-built LinkedIn metrics in the Metric Hub, which provide the closest possible translation to our previous content.
   
   
3. Add the new version of the pre-built LinkedIn metric from the Metric Hub and connect your data using your LinkedIn authentication token.
   
   
4. The historical data contained in your previous pre-built LinkedIn metric cannot be merged to the new pre-built content. However, you can display the previous pre-built LinkedIn metric (which will stop gathering data as of March 15th) alongside the new version.

Let us know if you have any questions. We are here to help!