LinkedIn ad API

Get a LinkedIn ad's details

curl --request POST \
  --url https://api.stophy.dev/v1/linkedin/ads/ad \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adUrl": "<string>",
  "adId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({adUrl: '<string>', adId: '<string>'})
};

fetch('https://api.stophy.dev/v1/linkedin/ads/ad', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/linkedin/ads/ad"

payload = {
    "adUrl": "<string>",
    "adId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "adUrl": "<string>",
    "imageUrls": [
      "<string>"
    ],
    "videoUrls": [
      "<string>"
    ],
    "countries": [
      {
        "country": "<string>",
        "share": 123
      }
    ],
    "targeting": [
      {
        "parameter": "<string>",
        "description": "<string>"
      }
    ],
    "targetingUsed": [
      {
        "isTargeted": true,
        "isExcluded": true,
        "parameter": "<string>"
      }
    ],
    "adId": "<string>",
    "creativeType": "<string>",
    "format": "<string>",
    "advertiserName": "<string>",
    "advertiserUrl": "<string>",
    "advertiserAvatarUrl": "<string>",
    "postedBy": "<string>",
    "text": "<string>",
    "headline": "<string>",
    "paidBy": "<string>",
    "ctaText": "<string>",
    "firstShownAt": "2023-11-07T05:31:56Z",
    "lastShownAt": "2023-11-07T05:31:56Z",
    "impressionsMin": 0,
    "impressionsMax": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

ads

Get a LinkedIn ad's details

curl --request POST \
  --url https://api.stophy.dev/v1/linkedin/ads/ad \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "adUrl": "<string>",
  "adId": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({adUrl: '<string>', adId: '<string>'})
};

fetch('https://api.stophy.dev/v1/linkedin/ads/ad', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/linkedin/ads/ad"

payload = {
    "adUrl": "<string>",
    "adId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "adUrl": "<string>",
    "imageUrls": [
      "<string>"
    ],
    "videoUrls": [
      "<string>"
    ],
    "countries": [
      {
        "country": "<string>",
        "share": 123
      }
    ],
    "targeting": [
      {
        "parameter": "<string>",
        "description": "<string>"
      }
    ],
    "targetingUsed": [
      {
        "isTargeted": true,
        "isExcluded": true,
        "parameter": "<string>"
      }
    ],
    "adId": "<string>",
    "creativeType": "<string>",
    "format": "<string>",
    "advertiserName": "<string>",
    "advertiserUrl": "<string>",
    "advertiserAvatarUrl": "<string>",
    "postedBy": "<string>",
    "text": "<string>",
    "headline": "<string>",
    "paidBy": "<string>",
    "ctaText": "<string>",
    "firstShownAt": "2023-11-07T05:31:56Z",
    "lastShownAt": "2023-11-07T05:31:56Z",
    "impressionsMin": 0,
    "impressionsMax": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Returns a LinkedIn ad’s details. The ad is identified by its URL or ID.

Request

Exactly one of adUrl or adId is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.linkedin.ads.ad({ adUrl: "https://www.linkedin.com/ad-library/detail/1234567" });
console.log(result.data);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.linkedin.ads.ad(ad_url="https://www.linkedin.com/ad-library/detail/1234567")
print(result["data"])

curl -X POST https://api.stophy.dev/v1/linkedin/ads/ad \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"adUrl":"https://www.linkedin.com/ad-library/detail/1234567"}'

stophy linkedin ads ad --adUrl https://www.linkedin.com/ad-library/detail/1234567

Response

If successful, the response body contains the standard envelope. data contains the ad’s advertiser, text and images, and who paid for it. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "adId": "1585529084",
    "adUrl": "https://www.linkedin.com/ad-library/detail/1585529084",
    "creativeType": "SPONSORED_STATUS_UPDATE",
    "format": "Single Image Ad",
    "advertiserName": "SiteChief",
    "advertiserUrl": "https://www.linkedin.com/company/106013271",
    "advertiserAvatarUrl": "https://media.licdn.com/dms/image/v2/D560BAQH_lWh0hAuxAA/company-logo_100_100/B56aDOxwFkIQAI-/0/1790175543945/lifesafet…",
    "text": "We’ve rebranded, LifeSafety.AI is now SiteChief.\nSame team. Same UK-built platform.\nA name that matches what customers…",
    "headline": "AI Health & Safety Software for Workplace | SiteChief UK",
    "imageUrls": ["https://media.licdn.com/dms/image/sync/v2/D4E27AQGrtnvrN16TKA/articleshare-shrink_1280_800/B4EaDEgSaVJoAg-/0/1790003193…"],
    "paidBy": "PODTECH"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`paidBy`	string	The entity that paid for the ad.

For every field, see the response schema on this page.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

This method is not paginated. A single request returns the complete result.

LinkedIn ads search: Accepts the advertiserName as advertiser. Searches ads in the LinkedIn ad library.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

adUrl

string

Link to the LinkedIn ad, like https://www.linkedin.com/ad-library/detail/1234567. Send this or adId.

adId

string

LinkedIn ad id, like 1234567. Send this or adUrl.

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

LinkedIn ad API

Request

Response

Billing

Authorizations

Body

Response

​Request

​Response

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Billing

Pagination

Related methods