Trigger Ad Library Scrapes
curl --request POST \
--url https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scrapers": [
"<string>"
],
"website_url": "<string>",
"country": "<string>",
"start_time": 123,
"end_time": 123,
"sort_type": "<string>",
"active_status": "<string>",
"brand_names": [
"<string>"
],
"brand_domains": [
"<string>"
],
"page_ids": [
"<string>"
],
"page_urls": [
"<string>"
],
"total_limit": 100,
"page_size": 100,
"meta_method": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes"
payload = {
"scrapers": ["<string>"],
"website_url": "<string>",
"country": "<string>",
"start_time": 123,
"end_time": 123,
"sort_type": "<string>",
"active_status": "<string>",
"brand_names": ["<string>"],
"brand_domains": ["<string>"],
"page_ids": ["<string>"],
"page_urls": ["<string>"],
"total_limit": 100,
"page_size": 100,
"meta_method": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scrapers: ['<string>'],
website_url: '<string>',
country: '<string>',
start_time: 123,
end_time: 123,
sort_type: '<string>',
active_status: '<string>',
brand_names: ['<string>'],
brand_domains: ['<string>'],
page_ids: ['<string>'],
page_urls: ['<string>'],
total_limit: 100,
page_size: 100,
meta_method: '<string>'
})
};
fetch('https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scrapers' => [
'<string>'
],
'website_url' => '<string>',
'country' => '<string>',
'start_time' => 123,
'end_time' => 123,
'sort_type' => '<string>',
'active_status' => '<string>',
'brand_names' => [
'<string>'
],
'brand_domains' => [
'<string>'
],
'page_ids' => [
'<string>'
],
'page_urls' => [
'<string>'
],
'total_limit' => 100,
'page_size' => 100,
'meta_method' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes"
payload := strings.NewReader("{\n \"scrapers\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"country\": \"<string>\",\n \"start_time\": 123,\n \"end_time\": 123,\n \"sort_type\": \"<string>\",\n \"active_status\": \"<string>\",\n \"brand_names\": [\n \"<string>\"\n ],\n \"brand_domains\": [\n \"<string>\"\n ],\n \"page_ids\": [\n \"<string>\"\n ],\n \"page_urls\": [\n \"<string>\"\n ],\n \"total_limit\": 100,\n \"page_size\": 100,\n \"meta_method\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scrapers\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"country\": \"<string>\",\n \"start_time\": 123,\n \"end_time\": 123,\n \"sort_type\": \"<string>\",\n \"active_status\": \"<string>\",\n \"brand_names\": [\n \"<string>\"\n ],\n \"brand_domains\": [\n \"<string>\"\n ],\n \"page_ids\": [\n \"<string>\"\n ],\n \"page_urls\": [\n \"<string>\"\n ],\n \"total_limit\": 100,\n \"page_size\": 100,\n \"meta_method\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scrapers\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"country\": \"<string>\",\n \"start_time\": 123,\n \"end_time\": 123,\n \"sort_type\": \"<string>\",\n \"active_status\": \"<string>\",\n \"brand_names\": [\n \"<string>\"\n ],\n \"brand_domains\": [\n \"<string>\"\n ],\n \"page_ids\": [\n \"<string>\"\n ],\n \"page_urls\": [\n \"<string>\"\n ],\n \"total_limit\": 100,\n \"page_size\": 100,\n \"meta_method\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"requested_at": "2023-11-07T05:31:56Z",
"enqueued": 123,
"skipped": 123,
"website_url": "<string>",
"discovered_social_links": {},
"jobs": [
{
"job_id": "<string>",
"scraper": "<string>",
"provider": "<string>",
"platform": "<string>",
"country": "<string>",
"limit": 123,
"offset": 123,
"advertiser_name": "<string>",
"advertiser_domain": "<string>",
"facebook_page_id": "<string>",
"facebook_page_url": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"sort_type": "<string>",
"active_status": "<string>"
}
],
"skipped_items": [
{
"scraper": "<string>",
"provider": "<string>",
"platform": "<string>",
"reason": "<string>",
"advertiser_name": "<string>",
"advertiser_domain": "<string>",
"facebook_page_id": "<string>",
"facebook_page_url": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Admin
Trigger Ad Library Scrapes
Queue broad public-ad library scrapes across configured providers.
POST
/
api
/
v1
/
admin
/
integrations
/
meta-ad-library
/
scrapes
Trigger Ad Library Scrapes
curl --request POST \
--url https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scrapers": [
"<string>"
],
"website_url": "<string>",
"country": "<string>",
"start_time": 123,
"end_time": 123,
"sort_type": "<string>",
"active_status": "<string>",
"brand_names": [
"<string>"
],
"brand_domains": [
"<string>"
],
"page_ids": [
"<string>"
],
"page_urls": [
"<string>"
],
"total_limit": 100,
"page_size": 100,
"meta_method": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes"
payload = {
"scrapers": ["<string>"],
"website_url": "<string>",
"country": "<string>",
"start_time": 123,
"end_time": 123,
"sort_type": "<string>",
"active_status": "<string>",
"brand_names": ["<string>"],
"brand_domains": ["<string>"],
"page_ids": ["<string>"],
"page_urls": ["<string>"],
"total_limit": 100,
"page_size": 100,
"meta_method": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scrapers: ['<string>'],
website_url: '<string>',
country: '<string>',
start_time: 123,
end_time: 123,
sort_type: '<string>',
active_status: '<string>',
brand_names: ['<string>'],
brand_domains: ['<string>'],
page_ids: ['<string>'],
page_urls: ['<string>'],
total_limit: 100,
page_size: 100,
meta_method: '<string>'
})
};
fetch('https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scrapers' => [
'<string>'
],
'website_url' => '<string>',
'country' => '<string>',
'start_time' => 123,
'end_time' => 123,
'sort_type' => '<string>',
'active_status' => '<string>',
'brand_names' => [
'<string>'
],
'brand_domains' => [
'<string>'
],
'page_ids' => [
'<string>'
],
'page_urls' => [
'<string>'
],
'total_limit' => 100,
'page_size' => 100,
'meta_method' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes"
payload := strings.NewReader("{\n \"scrapers\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"country\": \"<string>\",\n \"start_time\": 123,\n \"end_time\": 123,\n \"sort_type\": \"<string>\",\n \"active_status\": \"<string>\",\n \"brand_names\": [\n \"<string>\"\n ],\n \"brand_domains\": [\n \"<string>\"\n ],\n \"page_ids\": [\n \"<string>\"\n ],\n \"page_urls\": [\n \"<string>\"\n ],\n \"total_limit\": 100,\n \"page_size\": 100,\n \"meta_method\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scrapers\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"country\": \"<string>\",\n \"start_time\": 123,\n \"end_time\": 123,\n \"sort_type\": \"<string>\",\n \"active_status\": \"<string>\",\n \"brand_names\": [\n \"<string>\"\n ],\n \"brand_domains\": [\n \"<string>\"\n ],\n \"page_ids\": [\n \"<string>\"\n ],\n \"page_urls\": [\n \"<string>\"\n ],\n \"total_limit\": 100,\n \"page_size\": 100,\n \"meta_method\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/admin/integrations/meta-ad-library/scrapes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scrapers\": [\n \"<string>\"\n ],\n \"website_url\": \"<string>\",\n \"country\": \"<string>\",\n \"start_time\": 123,\n \"end_time\": 123,\n \"sort_type\": \"<string>\",\n \"active_status\": \"<string>\",\n \"brand_names\": [\n \"<string>\"\n ],\n \"brand_domains\": [\n \"<string>\"\n ],\n \"page_ids\": [\n \"<string>\"\n ],\n \"page_urls\": [\n \"<string>\"\n ],\n \"total_limit\": 100,\n \"page_size\": 100,\n \"meta_method\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"requested_at": "2023-11-07T05:31:56Z",
"enqueued": 123,
"skipped": 123,
"website_url": "<string>",
"discovered_social_links": {},
"jobs": [
{
"job_id": "<string>",
"scraper": "<string>",
"provider": "<string>",
"platform": "<string>",
"country": "<string>",
"limit": 123,
"offset": 123,
"advertiser_name": "<string>",
"advertiser_domain": "<string>",
"facebook_page_id": "<string>",
"facebook_page_url": "<string>",
"start_time": "<string>",
"end_time": "<string>",
"sort_type": "<string>",
"active_status": "<string>"
}
],
"skipped_items": [
{
"scraper": "<string>",
"provider": "<string>",
"platform": "<string>",
"reason": "<string>",
"advertiser_name": "<string>",
"advertiser_domain": "<string>",
"facebook_page_id": "<string>",
"facebook_page_url": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Maximum array length:
10Maximum string length:
2048Maximum string length:
8Maximum string length:
80Maximum string length:
20Maximum array length:
200Maximum array length:
200Maximum array length:
200Maximum array length:
200Required range:
1 <= x <= 10000Required range:
1 <= x <= 100Maximum string length:
40Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I