Social Fetch
Facebook

Get Facebook Ad Library ad

Get a single Facebook Ad Library ad by archive id or public Ad Library URL.

Operation

GET/v1/facebook/ad-library/ads
Cost: 1 credit

Headers

x-api-keystringrequired(header)

API key (`sfk_...`)

Parameters

adIdstring(query)

Facebook Ad Library archive id for the ad.

min 1 chars · max 4096 chars

urlstring(query)

Public Facebook Ad Library URL for the ad.

min 1 chars · max 4096 chars

includeTranscriptboolean(query)

When true, includes a plain-text transcript when available for the ad video.

trimboolean(query)

When true, requests a smaller upstream payload before normalization.

Response fields

data
objectrequired

Endpoint-specific response payload.

datalookupStatus
stringrequired

Whether the ad was found in the Ad Library.

one of: found, not_found

dataad
objectrequirednullable

Ad details when found; otherwise null.

dataadid
stringrequired

Stable identifier for the ad.

min 1 chars

dataadadId
stringrequirednullable

Platform ad id when available.

dataadurl
stringrequirednullable

Public Facebook Ad Library URL for this ad when available.

dataadpage
objectrequired

Advertiser page summary for this ad.

dataadpageid
stringrequirednullable

Facebook page id for the advertiser when available.

dataadpagename
stringrequirednullable

Display name for the advertiser page when available.

dataadpageurl
stringrequirednullable

Public Facebook URL for the advertiser page when available.

dataadpageisDeleted
booleanrequirednullable

Whether the advertiser page is marked deleted.

dataadpageprofilePictureUrl
stringrequirednullable

Profile picture URL for the advertiser page when available.

dataadpagelikeCount
integerrequirednullable

Advertiser page like count when available.

≥ 0

dataadpagecategories
arrayrequired

Public categories for the advertiser page when available.

dataadpagecategories[]
string

min 1 chars

dataadcampaign
objectrequired

Campaign collation metadata for this ad.

dataadcampaigncollationId
stringrequirednullable

Campaign collation id when available.

dataadcampaigncollationCount
integerrequirednullable

Number of ads in the campaign collation when available.

≥ 0

dataadisActive
booleanrequired

Whether the ad is currently active.

dataadpublisherPlatforms
arrayrequired

Publisher platforms where the ad ran or is running.

dataadpublisherPlatforms[]
string

min 1 chars

dataadstartedAt
stringrequirednullable

ISO-8601 timestamp for when the ad started, when available.

dataadendedAt
stringrequirednullable

ISO-8601 timestamp for when the ad ended, when available.

dataadcategories
arrayrequired

Ad categories reported by the platform.

dataadcategories[]
string

min 1 chars

dataadcountries
arrayrequired

Countries targeted or reached by the ad when available.

dataadcountries[]
string

min 1 chars

dataadimpressions
objectrequirednullable

Impressions metadata when available.

dataadimpressionstext
stringrequirednullable

Human-readable impressions label when available.

dataadimpressionsindex
integerrequirednullable

Impressions index when available.

dataadspend
objectrequirednullable

Spend metadata when available.

dataadspendamount
stringrequirednullable

Spend amount text when available.

dataadspendcurrency
stringrequirednullable

Currency code for spend when available.

dataadcreative
objectrequired

Creative content for this ad.

dataadcreativebodyText
stringrequirednullable

Primary ad body text when available.

dataadcreativetitle
stringrequirednullable

Ad title when available.

dataadcreativecaption
stringrequirednullable

Ad caption when available.

dataadcreativelinkUrl
stringrequirednullable

Primary link URL when available.

dataadcreativelinkDescription
stringrequirednullable

Link description when available.

dataadcreativecallToAction
stringrequirednullable

Call-to-action label when available.

dataadcreativecallToActionType
stringrequirednullable

Call-to-action type when available.

dataadcreativedisplayFormat
stringrequirednullable

Display format for the creative when available.

dataadcreativeimages
arrayrequired

Image assets attached to the creative.

dataadcreativeimages[]url
stringrequirednullable

Image URL when available.

dataadcreativeimages[]resizedUrl
stringrequirednullable

Resized image URL when available.

dataadcreativeimages[]watermarkedResizedUrl
stringrequirednullable

Watermarked resized image URL when available.

dataadcreativevideos
arrayrequired

Video assets attached to the creative.

dataadcreativevideos[]hdUrl
stringrequirednullable

High-definition video URL when available.

dataadcreativevideos[]sdUrl
stringrequirednullable

Standard-definition video URL when available.

dataadcreativevideos[]previewImageUrl
stringrequirednullable

Video preview image URL when available.

dataadcreativecards
arrayrequired

Carousel cards attached to the creative.

dataadcreativecards[]title
stringrequirednullable

Card title when available.

dataadcreativecards[]body
stringrequirednullable

Card body text when available.

dataadcreativecards[]caption
stringrequirednullable

Card caption when available.

dataadcreativecards[]linkUrl
stringrequirednullable

Card link URL when available.

dataadcreativecards[]imageUrl
stringrequirednullable

Card image URL when available.

dataadcreativecards[]videoUrl
stringrequirednullable

Card video URL when available.

datatranscript
stringrequirednullable

Plain transcript text when requested and available. May be null when speech is not detected, the video exceeds supported length, or transcription is otherwise unavailable.

meta
objectrequired

Metadata describing the request and billing outcome.

metarequestId
stringrequired

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integerrequired

Credits charged for this request.

≥ 0

metaversion
stringrequired

Public API version that served the response.

one of: v1

Code example

Responses

Ad Library ad detail (found or not found in body).

Error codes

bad_requestinsufficient_creditsinternal_errorlookup_failedtemporarily_unavailableunauthorized

On this page