Search API Connector Documentation
Import LinkedIn Ads Data to Google Sheets
In this guide, we will pull data from the LinkedIn API directly into Google Sheets, using the API Connector add-on for Sheets.
The LinkedIn API limits data for privacy reasons; don't expect a way to pull out profile information for anyone but yourself. However, this API is perfect for pulling out advertising performance data from the LinkedIn Ads Reporting API.
Contents
- Before You Begin
- Part 1: Connect to the LinkedIn Ads API
- Part 2: Pull Data from LinkedIn Ads to Sheets
- Part 3: Create a Custom API Request
- Part 4: Handle Pagination
- Part 5: Notes
- Part 6: API Documentation
Before You Begin
Click here to install the API Connector add-on from the Google Marketplace.
Part 1: Connect to the LinkedIn Ads API
The easiest way to get started with the LinkedIn Ads API is through API Connector’s built-in integration.
- Select LinkedIn Ads from the drop-down list of applications
- Under Authorization, click Connect to LinkedIn
- You will be directed to LinkedIn and asked to authorize the connection. Click Allow.
- You'll now be returned to your Google Sheet, and can verify that your LinkedIn API connection is active.
Part 2: Pull Data from LinkedIn Ads to Sheets
Now that we’re connected, let’s pull some data into Sheets.
- In the Endpoint section, choose
/adAnalytics?q=analyticsto get reporting data in your sheet.
- In the Request parameters section, select one or more of your accounts from the dropdown menu.
- Fill in the other required parameters:
dateRange,fields,pivot, andtimeGranularity. FordateRange, select fixed dates from the calendar input or use dynamic values from the cells in your sheet.
- Optionally enter the text
(,elements(*,pivotValue~()))under theprojectionfield. This will retrieve some additional useful fields like campaign names (without using projection, you'll get just the IDs). - Click Edit fields to select just the fields you want and assign them to specific columns in your report.
- Run your request.
Part 3: Create a Custom API Request
Alternatively, you can create a custom request instead of using API Connector’s built-in integration, using any of the API URLs shown in the API documentation. Here's a complete example request using LinkedIn's X-Restli protocol and their new versioned API:
- Application:
Custom - Method:
GET - Request URL:
https://api.linkedin.com/rest/adAnalytics?q=analytics&dateRange=(start:(day:01,month:11,year:2021),end:(day:30,month:11,year:2022))&pivot=CAMPAIGN&accounts=List(urn%3Ali%3AsponsoredAccount%3A507152744)&timeGranularity=DAILY&fields=pivot,pivotValue,dateRange,clicks,costInLocalCurrency,impressions - OAuth:
LinkedIn Ads - Headers
X-Restli-Protocol-Version:2.0.0LinkedIn-Version:202212
Part 4: Handle Pagination
By default, LinkedIn's /adAnalytics endpoint will return just 1000 records. To return more, apply API Connector's automatic pagination handling as follows
- Pagination:
next page URL - Next page path:
paging.links.href - Run until: choose when to stop fetching data
Part 5: Notes
- Use the visual field editor to re-arrange columns (just click Edit Fields before running your request).
- LinkedIn sends back dates split into separate year, month, and day fields. To transform these into a regular Sheets date, set a data destination of cell B1, and then add the following function into cell A1:
=arrayformula(if(J2:J<>"", date(J2:J,H2:H,I2:I),"")). The function assumes years are in column J, months are in H, and days are in I; adjust as needed. - To view or manage the connection on LinkedIn, click here: https://www.linkedin.com/psettings/permitted-services
Part 6: API Documentation
Official API documentation: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting
Can you post an example api using the q=statistics call? I'm trying to pull in multiple pivot values but I can't seem to get it to work.
Thanks
Hey Brian! Can you please try something like this?
https://api.linkedin.com/v2/adAnalyticsV2?q=statistics&pivots[0]=CAMPAIGN&pivots[1]=CREATIVE&dateRange.start.day=1&dateRange.start.month=1&dateRange.start.year=2019&timeGranularity=DAILY&campaigns[0]=urn:li:sponsoredCampaign:124782804&fields=externalWebsiteConversions,dateRange,impressions,landingPageClicks,likes,shares,costInLocalCurrency,pivot,pivotValuesThat seemed to work for me but I have a pretty limited data set to test on. Let me know how it goes.
This worked perfectly.
Thanks!
Hey, can you please help me get the name of an ad/creative?
I've tried using https://api.linkedin.com/v2/adCreativesV2/ but it doesn't return the creative's name.
Thanks!
Hi there, this URL should get you what you're looking for:
https://api.linkedin.com/v2/adCreativesV2?q=searchHi! This was incredibly helpful. Unfortunately all the campaign, campaign groups, creatives, and companies are coming in as numbers instead of using the actual names. So it's very hard to match up which campaign goes with which campaign code. Is there an API that pulls in the name instead of just the value?
Hey Kat! Thanks for the message. Can you please try this?
https://api.linkedin.com/v2/adCampaignsV2/?q=searchI believe it will return a list of all your campaigns with both names and IDs, so you can use that to match up the data from the other queries. There might be a better way but that's how I did it :p. Let me know if that works for you.
Edit: you can get this all in one go using projection, I put some examples above.
Hi I was hoping you might be able to give me some guidance.
I have all the data coming in fine, GREAT JOB, but i'm not able to pull any lead or conversion data from an Ad Campaign that is counting conversions as a download from LinkedIn itself.
Do you have any ideas the ExternalConversions won't work because its happening on LinkedIn. Thanks in Advance.
I can't say for sure, but if you click this #metrics-available link, you can see all the metrics that LinkedIn provides. I just looked through and some of these look they might be what you're looking for: actionClicks, adUnitClicks, cardClicks, clicks, companyPageClicks, landingPageClicks, oneClickLeadFormOpens, oneClickLeads, totalEngagements. If you check the link you can see the descriptions of each metric, so please check and see if they get you what you need. If so, you'd just add them into the fields parameter of your request URL. Let me know if that works or you have any questions.
Thank you, it turned out that oneClickLead was the correct one. Thank you for doing the work on this
I cant seem to do a POST request using LinkedIn Connection?
What is the reason for this? Is it because it is a paid feature or something else?
Hey Ben, this is because LinkedIn's API requires approval for each specific scope (permission). API Connector limits the scopes it requests to r_ads, r_ads_reporting, and r_basicprofile, which only allow getting, not posting, data. Sorry for the inconvenience. One option would be for you to create your own custom OAuth2 connection to Linkedin, then you could request whatever scopes you need. Or could you please let me know a bit more about what you're trying to do? I will consider requesting additional scopes in the future.
Hi Ana, I'm looking to generate many ads & campaigns in bulk for an ABM use case where we cite a company name. I have a Custom App with the necessary permissions.
Maybe I can connect using that Connection using your custom Connection option?
Yeah, if you've already made your app on LinkedIn's side, you should be able to set up API Connector's custom OAuth2 connection like this:
Name: Custom LinkedIn
Authorization Base URL:
https://www.linkedin.com/oauth/v2/authorization?scope=r_ads,r_ads_reporting,r_basicprofile(add on other scopes here)Token URL:
https://www.linkedin.com/oauth/v2/accessTokenClient ID: provided by LinkedIn
Client Secret: provided by LinkedIn
Custom OAuth gets added in the Manage Connections screen. As long as you add your ad management scopes to the base URL, you will be able to access whatever you need in LinkedIn's API. Can you please try that and see how it goes?
Hi Ana,
Thank you so much for providing the example on how to set up the API Connector for LinkedIn Developers.
I followed your steps but it looks like I'm missing something.
After doing as follows:
Name: Custom LinkedIn
Authorization Base URL: https://www.linkedin.com/oauth/v2/authorization?scope=r_ads,r_ads_reporting,r_basicprofile (add on other scopes here)
Token URL: https://www.linkedin.com/oauth/v2/accessToken
Client ID: provided by LinkedIn
Client Secret: provided by LinkedIn
However, I find 2 issues:
1) When adding "https://www.linkedin.com/oauth/v2/authorization?scope=r_ads,r_ads_reporting,r_basicprofile" to my authorization base URL, I get the following message: "Redirect URLs cannot contain commas".
2)If I just include 1 scope and try to run the connection, I get the following message from LinkedIn: "Bummer, something went wrong. The redirect_uri does not match the registered value!"
I checked and both URLs where exactly the same.
What am I missing?
Thanks in advance!
1) The authorization base URL should be encoded, can you please try this instead?
https://www.linkedin.com/oauth/v2/authorization?scope=r_ads%2Cr_ads_reporting%2Cr_basicprofile2) For the redirect_uri, please make sure you've given them the correct URL. From what you wrote above it sounds like you may be mixing up the authorization base URLs with the redirect URL. The redirect URL is a URL that you provide to LinkedIn, it should be
https://script.google.com/macros/d/12COOkin8nodCH7fZGIBu0D2jWY8-AEA0uvElt4Ph4wRbLUD4wslqQUfG/usercallbackLet me know how that goes or feel free to send a message if you're still stuck.
Seems to work now, excellent. Thanks for your help!
Hi,
Thanks you so much for this instruction, very helpful and I came from knowing nothing how this works to almost managed to get everything I need 🙂 Could you maybe help me with the last bit? I managed to get demographic data with pivot on "member_company", where I can see the company's organization id. I need to match the ids with the organization names, but I can't get the organization endpoint to work. Do you maybe have experience with this? Thanks in advance.
You can get it via the
projectionandpivotValue~(localizedName)parameters, like this:https://api.linkedin.com/v2/adAnalyticsV2?q=analytics&dateRange.start.year=2021&dateRange.start.month=5&dateRange.start.day=28&dateRange.end.year=2021&dateRange.end.month=9&dateRange.end.day=30&timeGranularity=MONTHLY&accounts=urn:li:sponsoredAccount:502849368&pivot=MEMBER_COMPANY&projection=(*,elements*(externalWebsiteConversions,dateRange(*),impressions,landingPageClicks,likes,shares,costInLocalCurrency,approximateUniqueImpressions,pivot,pivotValue~(localizedName)))&fields=externalWebsiteConversions,dateRange,impressions,landingPageClicks,likes,shares,costInLocalCurrency,pivot,pivotValueThank you so much 🙂
how to connect the Linkedin API to obtain the access token with Oauth2.0, for a python development environment, thanks!
This is LinkedIn's documentation on connecting via OAuth2.0, it shows the step by step flow to get a token: https://docs.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow?tabs=HTTPS
Hey, can you please help me to what the event registration refers to which field?
And the api to get the event registration, click event registration, and view event registration.
Thanks.
I think that would all be part of the Events API: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/community-management/organizations/events?tabs=http
Hi, Can you help me providing an example of an api for pivot = CONVERSION?
“pivot” (aka breakdown) values:
COMPANY – Group results by advertiser’s company.
ACCOUNT – Group results by account.
CAMPAIGN – Group results by campaign.
CREATIVE – Group results by creative.
CONVERSION – Group results by conversion.
It should be similar to the examples above, but with fields that make sense with the Conversions pivot, e.g.
https://api.linkedin.com/v2/adAnalyticsV2?q=analytics&pivot=CONVERSION&dateRange.start.day=1&dateRange.start.month=1&dateRange.start.year=2021&timeGranularity=DAILY&accounts[0]=urn:li:sponsoredAccount:502849368&fields=conversionValueInLocalCurrency,externalWebsiteConversions,externalWebsitePostClickConversions,externalWebsitePostViewConversions,viralExternalWebsiteConversions,viralExternalWebsitePostClickConversions,viralExternalWebsitePostViewConversionsLet me know if that works for you!
Thanks! Any idea how to use conversionActionType =
"SIGN_UP" ?
Sorry, I'm not sure what you mean by how to use it. I see a little bit about conversionActionType in this article: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/conversion-tracking
Hi Ana,
I am having trouble with getting Creative names. For campaigns I can use "name" as a field and pull all the names from certain account in one call. But with the adCreatives I can't seem to get it to work. Could you help? Thank you.
Does
https://api.linkedin.com/v2/adCreativesV2?q=searchwork for you? Or can you please share the URL you're using for campaigns so I can better understand what you mean?Hi Ana,
thanks for your quick reply.
This call still gives empty result, there is no error but the cells are empty. Could it be because we don't have any Text Ads? The most we have are Sponsored Content. I read the post you sent as well, but I don't know how to use projection in this case. Could you help? Thanks in advance.
Yeah it looks like sponsored content requires a different kind of call. You'll need to do it like this:
1) get your ad creatives for a specific campaign:
https://api.linkedin.com/v2/adCreativesV2?q=search&search.campaign.values[0]=urn:li:sponsoredCampaign:111111112) It will return a field called elements.reference. Plug that value into a URL like this:
https://api.linkedin.com/v2/adDirectSponsoredContents/urn:li:ugcPost:11111111That will return the name of your sponsored content.
This is really a very awkward and inconvenient API. Maybe there's an easier way but their documentation is too confusing for me to figure out 😛
Hi. I have built a request for data with Account and Campaign pivots for multiple accounts - I am observing that the projection decoration does only work for single accounts - so now I do multiple requests for each account to get account + campaign details. Have you observed this too?
Not sure, but if you'd like to share your request URL, I could run it on this side and let you know if I get the same results.
Single accounts request URL (= the one I am working with now):
https://api.linkedin.com/v2/adAnalyticsV2?q=statistics&dateRange=(start:(day:1,month:1,year:2020))&timeGranularity=MONTHLY&pivots=List(CAMPAIGN,ACCOUNT)&fields=dateRange,impressions,clicks,costInLocalCurrency,costInUsd,totalEngagements,likes,comments,follows,shares,companyPageClicks,landingPageClicks,opens,externalWebsiteConversions,pivot,pivotValues&accounts=List(urn%3Ali%3AsponsoredAccount%3A${accountId})&count=500&projection=(*,elements*(*,pivotValues(*~sponsoredCampaign(id,name,type,status)~sponsoredAccount(id,name,type,status))))-
URL with a multiple advertising accounts - where I do not receive any data from the projected pivot fields:
https://api.linkedin.com/v2/adAnalyticsV2?q=statistics&dateRange=(start:(day:1,month:1,year:2020))&timeGranularity=MONTHLY&pivots=List(CAMPAIGN,ACCOUNT)&fields=dateRange,impressions,clicks,costInLocalCurrency,costInUsd,totalEngagements,likes,comments,follows,shares,companyPageClicks,landingPageClicks,opens,externalWebsiteConversions,pivot,pivotValues&accounts=List(urn%3Ali%3AsponsoredAccount%3A${accountId1},urn%3Ali%3AsponsoredAccount%3A${accountId2},urn%3Ali%3AsponsoredAccount%3A${accountId3})&count=500&projection=(*,elements*(*,pivotValues(*~sponsoredCampaign(id,name,type,status)~sponsoredAccount(id,name,type,status))))Both requests actually worked fine for me, I got the projected fields back even with multiple account IDs. I wonder if the issue you're having is related to encoding. Their docs say "The values and the resource parameters must be URL encoded but not the , grouping the fields and values. The single resource key had the , encoded because it was part of the whole value."
I want to get the new leads from the ads that fill the forms
Is this what you're looking for? https://docs.microsoft.com/en-us/linkedin/marketing/integrations/lead-gen/ads-leadgen
If so, you can try a request like this:
https://api.linkedin.com/v2/adForms?q=account&account=urn:li:sponsoredAccount:111111111&totals=true&count=1&start=0Hi is it possible to catch the data about spended money on concrete campaign ?
Sure, you can use the costInLocalCurrency and costInUsd fields, e.g.
https://api.linkedin.com/v2/adAnalyticsV2?q=analytics&timeGranularity=MONTHLY&dateRange.start.year=2021&dateRange.start.month=1&dateRange.start.day=1&dateRange.end.year=2021&dateRange.end.month=2&dateRange.end.day=1&pivot=CAMPAIGN&fields=costInLocalCurrency,costInUsd,dateRange,pivotValues&accounts[0]=urn:li:sponsoredAccount:123456789Hi how to get the ad creative names ?
It depends on the specific ad type, but generally you can get it through projection or by directly calling the adCreatives endpoint:
https://api.linkedin.com/v2/adCreativesV2?q=searchi want to get the video title with the image i managed. Do you maybe have any idea ?
This should work:
1. After you run
https://api.linkedin.com/v2/adCreativesV2?q=searchyou should see a field called elements.reference, where the values look likeurn:li:ugcPost:6861589830204235777.2. Take the value you're interested in and plug it into this URL like this:
https://api.linkedin.com/v2/adDirectSponsoredContents/urn:li:ugcPost:6861589830204235777When I do that I get a video title back, please check if it works for you. You can also loop through multiple ugcPost ideas to get all the video names.
Hi Ana,
last week you supported me to connect Linkedin Pages and it has worked correctly. I am currently trying to connect Linkedin Ads but when I connect it, in Linkedin Pages requests I get an error: {"serviceErrorCode":65601,"message":"The token used in the request has been revoked by the user","status ":401}. When I connect Linkedin Pages again I get the same error for Ads requests. Is there a problem with having both connected simultaneously?
I really appreciate your support.
I just tested and was able to connect and run requests from both LinkedIn Ads and LinkedIn Pages, so I'm not yet sure what the issue is. Are you connecting each connection to the same LinkedIn account?
Which metric/field provides the name of the ads
You can enter
projection=(,elements(*,pivotValue~()))to retrieve ad names and other metadata. You can find theprojectionfield in the integration menu, or enter it manually in a custom request.@Ana, thanks for good example. i am trying to get all the performance metrics for all my campaing and using this endpoint :
https://api.linkedin.com/v2/adAnalyticsV2?q=campaign&dateRange.start.day=01&dateRange.start.month=01&dateRange.start.year=2023&dateRange.end.day=31&dateRange.end.month=01&dateRange.end.year=2023&pivot=DEMOGRAPHICS&fields=impressions,clicks,ctr,socialActions,videoViews,cpc,cpm,conversions,conversionRate,averageEngagement,engagementRate,frequency,spendBut does not work, where am i going wrong?
Looks like you're using the old v2 endpoints, which are now deprecated. Please check the custom request example above for an example using their new versioned API. You can also try using our preset integration instead as it's a lot easier to set up the requests.
Ana, your reply is much appreciated. How can I use your preset integration ?
Connect to LinkedIn as shown here, and then select LinkedIn from the dropdown menu as shown here. Just let me know if anything isn't clear and I'll be happy to help.
These are the fields that i want to bring into my worksheet.
Spent,Impressions,Clicks,Average CTR,Bid,Average CPM,Average CPC,Conversions,Cost Per,Conversion,Leads,Cost Per Lead
/adAnalytics?q=analytics is correct. Pivot =ACCOUNT but in the fields i cannot find the fields mentioned above. How do i achieve this?
You can see the full list of metrics available via API here: https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ads-reporting?view=li-lms-2023-06&tabs=http#metrics-available
I believe all those metrics are available through API Connector, but if not, you can type them into the dropdown to manually add them to the list.
Please note that the names of API metrics are different from the metrics in the interface, e.g. the interface uses the word "Spent" while the API uses "costInLocalCurrency". Other metrics aren't provided at all via API and need to be calculated, e.g. "Average CPM" would be costInLocalCurrency divided by 1000 impressions.
Thank you very mcuh for clarifying and your help has been absolutely fantastic!
https://api.linkedin.com/v2/adAnalyticsV2?q=statistics&pivots[0]=CAMPAIGN&pivots[1]=CREATIVE&dateRange.start.day=1&dateRange.start.month=1&dateRange.start.year=2019&timeGranularity=DAILY&campaigns[0]=urn:li:sponsoredCampaign:124782804&fields=externalWebsiteConversions,dateRange,impressions,landingPageClicks,likes,shares,costInLocalCurrency,pivot,pivotValuesHi Ana, can you help me revise the above to get the
all campaign names
all creative names
daily segments
and dates by cell reference?
I don't think you can get all campaign & creative names in one API call (actually it's never been very clear how to get LinkedIn creative names at all -- they gave me a "cheat sheet" which you can see here). However, in general, if you want to get campaign names, you'd use projection,e.g.
&projection=(,elements(*,pivotValue~())), and if you want to use cell references you can reference the bits you'd like to reference with plus signs, e.g.+++Sheet1!A1+++.I suggest using API Connector's built-in integration, because this is a very complex API that's not easy to understand or customize. If you would prefer to create a custom request, please use the custom request example as a starting point, because the example you've provided uses LinkedIn's deprecated API that will be removed soon.
Hey there! Is there any way to search for all Campaign names within a specific Campaign Group?
Cannot for the life of me get this to work: https://api.linkedin.com/v2/adCampaignsV2?q=search to work, just throws error:
{"message":"Request would return too many entities. .","status":400}
Also, alternatively... and this is a lonnnnng shot... any way to extract links from individual ads? Would love to be able to see and parse UTM parameters from listed ads. Thanks!
{"message":"Request would return too many entities. .","status":400}
This error occurs when you have more than 1000 records (info).
Can you please try running that request using API Connector's preset integration instead? (Select LinkedIn Ads > Get Available Campaigns from API Connector's dropdown application menu). That way you'll a) be using LinkedIn's newest API (the v2 syntax you used will be deprecated soon), and b) can set the "count" parameter to 1000 or lower, and use pagination to get all the records.
any way to extract links from individual ads?
I think you can also do this using API Connector's preset integration. Select your account, date range, and fields, set pivot to CREATIVE, and set projection to
(*,elements*(*,pivotValue~())). That should retrieve a field named "content.textAd.landingPage" that contains the full landing page URL.Thank you!
Very clear explanation, thank you!
I only recieve this as the output when following custom GET request with Linkedin OAUTH copied and pasted from the example. This is what it was giving me previously with no changes when the query criteria changed
paging.start paging.count paging.links.1 elements.1
0 10
That means the request worked but LinkedIn didn't send back any data. I'd double check that the account you authenticated with has ads data available for the time period you've selected.