HarvestAPI: Get Ad

Retrieve one LinkedIn ad by ad ID or URL.

Tool ID: harvestapi_get_ad

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'harvestapi_get_ad',
  {
    "adId": "ad_123",
    "url": "https://example.com"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute harvestapi_get_ad --input '{
  "adId": "ad_123",
  "url": "https://example.com"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "status": 1,
    "error": "example"
  }
}

Use deepline describe harvestapi_get_ad --json for the latest machine-readable contract.

Input reference

Retrieve detailed information about a specific LinkedIn Ad using its unique ID.

Name	Type	Required	Default	Details
`payload.adId`	`string`	No	—	The unique identifier of the LinkedIn Ad. Minimum length: 1.
`payload.url`	`string`	No	—	The URL of the LinkedIn Ad. Minimum length: 1.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	—
`result.data.element`	`object`	No	—	Provider response payload.
`result.data.element.id`	`string`	Yes	—	—
`result.data.element.variants`	`array`	Yes	—	—
`result.data.element.variants[].advertiser`	`object`	Yes	—	—
`result.data.element.variants[].advertiser.name`	`string \| null`	No	—	—
`result.data.element.variants[].advertiser.linkedinUrl`	`string`	No	—	—
`result.data.element.variants[].advertiser.imageUrl`	`string \| null`	No	—	—
`result.data.element.variants[].advertiser.headline`	`string \| null`	No	—	—
`result.data.element.variants[].content`	`object`	Yes	—	—
`result.data.element.variants[].content.description`	`string \| null`	No	—	—
`result.data.element.variants[].content.imageUrl`	`string \| null`	No	—	—
`result.data.element.variants[].content.videoThumbnailUrl`	`string \| null`	No	—	—
`result.data.element.variants[].content.videoSource`	`null`	No	—	—
`result.data.element.variants[].content.targetUrl`	`string \| null`	No	—	—
`result.data.element.variants[].content.headline`	`string \| null`	No	—	—
`result.data.element.variants[].content.ctaLabel`	`string \| null`	No	—	—
`result.data.element.variants[].content.slides`	`array`	No	—	—
`result.data.element.variants[].content.slides[].imageUrl`	`string \| null`	No	—	—
`result.data.element.variants[].content.slides[].targetUrl`	`string \| null`	No	—	—
`result.data.element.variants[].content.slides[].title`	`string \| null`	No	—	—
`result.data.element.variants[].creativeType`	`string \| null`	Yes	—	—
`result.data.element.about`	`object`	Yes	—	—
`result.data.element.about.format`	`string \| null`	No	—	—
`result.data.element.about.advertiserName`	`string \| null`	No	—	—
`result.data.element.about.advertiserUrl`	`string \| null`	No	—	—
`result.data.element.about.paidBy`	`string \| null`	No	—	—
`result.data.element.about.ranFrom`	`string \| null`	No	—	—
`result.data.element.about.ranTo`	`string \| null`	No	—	—
`result.data.element.impressions`	`object \| null`	Yes	—	—
`result.data.element.impressions.total`	`string \| null`	No	—	—
`result.data.element.impressions.byCountry`	`array`	No	—	—
`result.data.element.impressions.byCountry[].name`	`string \| null`	No	—	—
`result.data.element.impressions.byCountry[].percentage`	`string \| null`	No	—	—
`result.data.element.targeting`	`object \| null`	Yes	—	—
`result.data.element.targeting.segments`	`array`	Yes	—	—
`result.data.element.targeting.segments[].name`	`string`	Yes	—	—
`result.data.element.targeting.segments[].includes`	`array`	Yes	—	—
`result.data.element.targeting.segments[].excludes`	`array`	Yes	—	—
`result.data.element.targeting.parameters`	`array`	Yes	—	—
`result.data.element.targeting.parameters[].name`	`string`	Yes	—	—
`result.data.element.targeting.parameters[].targeted`	`boolean`	Yes	—	—
`result.data.element.targeting.parameters[].excluded`	`boolean`	Yes	—	—
`result.data.status`	`string \| integer`	No	—	—
`result.data.error`	`string \| null`	No	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0.02 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation