facebook

Adlibrary › Company › Ads

Returns the ads one company or page is running in the Facebook Ad Library, each with its creative, status, spend, and targeting info.

Use it when you know the advertiser by pageId or company name; to find ads by keyword across advertisers, use adlibrary/search/ads.

Metered: 50–350 credits. We reserve the ceiling when the call starts and charge what it actually used when it finishes.

Paginates by cursor: see Pagination.

get/v1/facebook/adlibrary/company/ads

Request

  • Base URL: https://api.insightsocial.app
  • URL: https://api.insightsocial.app/v1/facebook/adlibrary/company/ads
  • Auth: API key in header x-api-key

Query parameters

pageIdstring

Facebook page ID of the advertiser. Provide at least one of: pageId, companyName.

companyNamestring
Example:Lululemon

The name of the company. Can either use this or pageId. Provide at least one of: pageId, companyName.

countrystring

This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL.

status'ALL' | 'ACTIVE' | 'INACTIVE'

Status of the ad. Defaults to ACTIVE.

media_type'ALL' | 'IMAGE' | 'VIDEO' | 'MEME' | 'IMAGE_AND_MEME' | 'NONE'

Media type of the ad: ALL (default), IMAGE, VIDEO, MEME (an image with text on it), IMAGE_AND_MEME or NONE.

languagestring

Language to filter ads on. Needs to be 2 letter language code, ie EN, ES, FR, etc

sort_by'total_impressions' | 'relevancy_monthly_grouped'

Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions.

start_datestring

Start date to search for. Format: YYYY-MM-DD

end_datestring

End date to search for. Format: YYYY-MM-DD

cursorstring

Cursor to paginate through results

trimboolean

Set to true for a lighter record with fewer fields.

include'audience'

Set to audience (one token only) to fill, on every ad that ran in the EU, post.ext.ad.eu_total_reach, post.ext.ad.eu_reach_breakdown (reach per EU country by age band and gender), post.ext.ad.targets_eu, target_ages, target_gender and target_locations. Without it the call is unchanged.

sincestring

Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following next_cursor, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept.

untilstring

Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept.

dry_run'1'

Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.

Response

Success.

successtrue required
platformstring required
endpointstring required
schema_version'2' required
unavailablestring[] required
credits_usedinteger required
credits_remaininginteger required
request_idstring required
cachedboolean required
idempotent_replayboolean required
charge_reasonstring required
free_callboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.